{ "openapi": "3.0.0", "info": { "title": "Security Director Cloud APIs", "description": "API for managing shared security objects like IPS profiles, content filtering profiles, and security policies, API for managing firewall security policies and rules, API for managing Network Address Translation (NAT) policies", "contact": {}, "version": "1.0.0" }, "servers": [ { "url": "https://api.sdcloud.juniperclouds.net/", "variables": {} } ], "paths": { "/api/v2/change-password": { "post": { "tags": [ "IAM" ], "summary": "ChangePassword", "description": "", "operationId": "ChangePassword", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamChangePasswordRequest" }, { "example": { "email": "string", "current_password": "string", "new_password": "string" } } ] }, "example": { "email": "string", "current_password": "string", "new_password": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamChangePasswordResponse" }, { "example": { "status": "SUCCESS" } } ] }, "example": { "status": "SUCCESS" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/role/{ID}": { "get": { "tags": [ "IAM" ], "summary": "GetRole", "description": "", "operationId": "GetRole", "parameters": [ { "name": "ID", "in": "path", "description": "ID of the role.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRoleResponse" }, { "example": { "role": { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } } } ] }, "example": { "role": { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/roles": { "get": { "tags": [ "IAM" ], "summary": "ListRoles", "description": "", "operationId": "ListRoles", "parameters": [ { "name": "spec.size", "in": "query", "description": "Max number of entries to fetch.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "spec.from", "in": "query", "description": "Starting offset of entries to fetch.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListRolesResponse" }, { "example": { "roles": [ { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } ], "role_count": "string" } } ] }, "example": { "roles": [ { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } ], "role_count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/send-activate-user-email": { "post": { "tags": [ "IAM" ], "summary": "SendActivateUserEmail", "description": "", "operationId": "SendActivateUserEmail", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamSendEmailRequest" }, { "example": { "email": "string" } } ] }, "example": { "email": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/tenant/tenant-id": { "get": { "tags": [ "IAM" ], "summary": "GetTokenScope", "description": "", "operationId": "GetTokenScope", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamGetTokenScopeResponse" }, { "example": { "tenant_id": "string" } } ] }, "example": { "tenant_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/user": { "post": { "tags": [ "IAM" ], "summary": "CreateUser", "description": "", "operationId": "CreateUser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateUserRequest" }, { "example": { "user_name": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "role_id": "string", "role_name": "string" } ], "user_properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } } ] }, "example": { "user_name": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "role_id": "string", "role_name": "string" } ], "user_properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamCreateUserRPCResponse" }, { "example": { "uuid": "string" } } ] }, "example": { "uuid": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/user/{user_id}": { "get": { "tags": [ "IAM" ], "summary": "GetUser", "description": "", "operationId": "GetUser", "parameters": [ { "name": "user_id", "in": "path", "description": "ID of the user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetUserResponse" }, { "example": { "user_info": { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } } } ] }, "example": { "user_info": { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IAM" ], "summary": "EditUser", "description": "", "operationId": "EditUser", "parameters": [ { "name": "user_id", "in": "path", "description": "Mandatory: User UUID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditUserRequest" }, { "example": { "user_id": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "scope_name": "string", "scope_group_id": "string", "scope_group_name": "string", "role_id": "string", "role_name": "string" } ], "properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } } ] }, "example": { "user_id": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "scope_name": "string", "scope_group_id": "string", "scope_group_name": "string", "role_id": "string", "role_name": "string" } ], "properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamEditUserResponse" }, { "example": { "uuid": "string" } } ] }, "example": { "uuid": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/user/{uuid}": { "delete": { "tags": [ "IAM" ], "summary": "DeleteUser", "description": "", "operationId": "DeleteUser", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the user to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/iamDeleteUserRPCResponse" }, { "example": { "uuid": "string" } } ] }, "example": { "uuid": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/users": { "get": { "tags": [ "IAM" ], "summary": "ListUsers", "description": "", "operationId": "ListUsers", "parameters": [ { "name": "spec.size", "in": "query", "description": "Max number of entries to fetch.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "spec.from", "in": "query", "description": "Starting offset of entries to fetch.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListUsersResponse" }, { "example": { "users": [ { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } ], "user_count": "string" } } ] }, "example": { "users": [ { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } ], "user_count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError" } } } }, "default": { "description": "An unexpected error response", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/runtimeError" }, { "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } ] }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/bulk_site": { "post": { "tags": [ "Site Management" ], "summary": "CreateBulkSite", "description": "", "operationId": "CreateBulkSite", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBulkSiteRequest" }, { "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } } ] }, "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/external-probe": { "get": { "tags": [ "Site Management" ], "summary": "GetExternalProbe", "description": "Get a tenant object", "operationId": "GetExternalProbe", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetExternalProbeResponse" }, { "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } } ] }, "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Site Management" ], "summary": "DeleteExternalProbe", "description": "Delete a tenant object", "operationId": "DeleteExternalProbe", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Site Management" ], "summary": "CreateExternalProbe", "description": "create tenate object", "operationId": "CreateExternalProbe", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExternalProbeRequest" }, { "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } } ] }, "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/ipsec-profile": { "post": { "tags": [ "Site Management" ], "summary": "CreateIpsecProfile", "description": "Create an ipsec profile", "operationId": "CreateIpsecProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIpsecProfile" }, { "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } } } ] }, "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/ipsec-profile/{profile_name}": { "get": { "tags": [ "Site Management" ], "summary": "GetIpsecProfile", "description": "Get a ipsec profile", "operationId": "GetIpsecProfile", "parameters": [ { "name": "profile_name", "in": "path", "description": "Mandatory: Name of ipsec profile.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetIpsecProfileResponse" }, { "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } } ] }, "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Site Management" ], "summary": "DeleteIpsecProfile", "description": "Delete a ipsec profile", "operationId": "DeleteIpsecProfile", "parameters": [ { "name": "profile_name", "in": "path", "description": "Mandatory: Name of the ipsec profile.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Site Management" ], "summary": "UpdateIpsecProfile", "description": "Update a ipsec profile", "operationId": "UpdateIpsecProfile", "parameters": [ { "name": "profile_name", "in": "path", "description": "Mandatory: Name of ipsec profile.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIpsecProfile" }, { "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } } } ] }, "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/ipsec-profiles": { "get": { "tags": [ "Site Management" ], "summary": "GetIpsecProfileList", "description": "", "operationId": "GetIpsecProfileList", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetIpsecProfileListResponse" }, { "example": { "profiles": [ { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } ], "total": 1 } } ] }, "example": { "profiles": [ { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } ], "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/site": { "post": { "tags": [ "Site Management" ], "summary": "CreateSite", "description": "", "operationId": "CreateSite", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSiteRequest" }, { "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } } ] }, "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/site/prevalidate": { "post": { "tags": [ "Site Management" ], "summary": "ValidateSiteParams", "description": "Validate Site Params Request", "operationId": "ValidateSiteParams", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateSiteParamsRequest" }, { "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } } ] }, "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateSiteParamsResponse" }, { "example": { "response": "string" } } ] }, "example": { "response": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/site/{site_name}": { "get": { "tags": [ "Site Management" ], "summary": "GetSite", "description": "", "operationId": "GetSite", "parameters": [ { "name": "site_name", "in": "path", "description": "Mandatory: Name of the site to get.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetSiteDetailsResponse" }, { "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ {} ], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ {} ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" }, "total": 1 } } ] }, "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ {} ], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ {} ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" }, "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Site Management" ], "summary": "DeleteSite", "description": "", "operationId": "DeleteSite", "parameters": [ { "name": "site_name", "in": "path", "description": "Mandatory: Name of the site to update.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Site Management" ], "summary": "UpdateSite", "description": "", "operationId": "UpdateSite", "parameters": [ { "name": "site_name", "in": "path", "description": "Mandatory: Name of site to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSiteRequest" }, { "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } } ] }, "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/site/{site_name}/deploy": { "post": { "tags": [ "Site Management" ], "summary": "DeploySite", "description": "", "operationId": "DeploySite", "parameters": [ { "name": "site_name", "in": "path", "description": "Mandatory: Name of the site to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeploySiteRequest" }, { "example": { "undeploy": true } } ] }, "example": { "undeploy": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/sites": { "get": { "tags": [ "Site Management" ], "summary": "GetSiteList", "description": "", "operationId": "GetSiteList", "parameters": [ { "name": "spec.size", "in": "query", "description": "Optional: Max number of entries to fetch. Sets this limit as 100 by default if left blank.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "spec.from", "in": "query", "description": "Optional: Starting offset of entries to fetch. Starts from 0 if left blank.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetSiteListResponse" }, { "example": { "sites": [ { "site_name": "string", "description": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": {}, "tunnel_info": [], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ {} ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" } ], "total": 1 } } ] }, "example": { "sites": [ { "site_name": "string", "description": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": {}, "tunnel_info": [], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ {} ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" } ], "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/tunnel/{tunnel_id}": { "get": { "tags": [ "Site Management" ], "summary": "GetTunnel", "description": "Get details for a single tunnel, by name", "operationId": "GetTunnel", "parameters": [ { "name": "tunnel_id", "in": "path", "description": "Mandatory: ID of tunnel to fetch.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTunnelResponse" }, { "example": { "tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } } ] }, "example": { "tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/tunnels": { "get": { "tags": [ "Site Management" ], "summary": "ListTunnels", "description": "Get status of all tunnels", "operationId": "ListTunnels", "parameters": [ { "name": "spec.size", "in": "query", "description": "Optional: Max number of entries to fetch. Sets this limit as 100 by default if left blank.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "spec.from", "in": "query", "description": "Optional: Starting offset of entries to fetch. Starts from 0 if left blank.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListTunnelsResponse" }, { "example": { "tunnels": [ { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } ], "total": "string" } } ] }, "example": { "tunnels": [ { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } ], "total": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/tunnels/status/count": { "get": { "tags": [ "Site Management" ], "summary": "TunnelCount", "description": "Get counts of all tunnels by status", "operationId": "TunnelCount", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TunnelCountResponse" }, { "example": { "not_monitored_count": "string", "up_count": "string", "down_count": "string", "total_count": "string" } } ] }, "example": { "not_monitored_count": "string", "up_count": "string", "down_count": "string", "total_count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/{tenant_pop_id}/users/count": { "get": { "tags": [ "Site Management" ], "summary": "GetUsersTenantPop", "description": "Get number of users available in service instance", "operationId": "GetUsersTenantPop", "parameters": [ { "name": "tenant_pop_id", "in": "path", "description": "Mandatory: The ID of the tenant pop.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTenantPopListResponse" }, { "example": { "max_users": "string", "avail_users": "string" } } ] }, "example": { "max_users": "string", "avail_users": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/tenant-pops": { "get": { "tags": [ "Service Location Management" ], "summary": "GetTenantPopList", "description": "", "operationId": "GetTenantPopList", "parameters": [ { "name": "spec.size", "in": "query", "description": "This field is optional. This is to limit the number of tenant POPs(service locations) returned. A user can set the parameter spec.size as the limit. In the absence of this field, all requested information will be shown.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "spec.from", "in": "query", "description": "This field is optional. To set an offset, the user can set this parameter to contain the offset.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTenantPopListResponse1" }, { "example": { "tenant_pops": [ { "tenant_pop": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } } ], "total": 1 } } ] }, "example": { "tenant_pops": [ { "tenant_pop": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } } ], "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/pac-file/{name}": { "get": { "tags": [ "PAC Manager" ], "summary": "GetPacFile", "description": "Get a pac file.", "operationId": "GetPacFile", "parameters": [ { "name": "name", "in": "path", "description": "Mandatory: Name of the pac file. Call GET: /api/v2/pac-files to get the names of PAC files present in the system.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PACFileInfo" }, { "example": { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } } ] }, "example": { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v2/pac-files": { "get": { "tags": [ "PAC Manager" ], "summary": "ListPacFiles", "description": "List all of the tenant's pac files.", "operationId": "ListPacFiles", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PacFilesResponse" }, { "example": { "pac_files": [ { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } ] } } ] }, "example": { "pac_files": [ { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices": { "get": { "tags": [ "Device Onboarding" ], "summary": "ListDevices", "description": "Get a paginated collection of devices with filtering and sorting options.", "operationId": "ListDevices", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDevicesResponse" }, { "description": "ListDevicesResponse represents the response containing a list of devices and metadata.\nThis message provides both the device data and pagination information.", "example": { "items": [ { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}": { "get": { "tags": [ "Device Onboarding" ], "summary": "GetDevice", "description": "Retrieve a specific device by UUID. Fetches detailed information about a device using its unique identifier.", "operationId": "GetDevice", "parameters": [ { "name": "device_uuid", "in": "path", "description": "device_uuid is the unique identifier of the device to retrieve.\nThis field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceResponse" }, { "description": "GetDeviceResponse represents the response containing a single device's information.\nThis message is returned when a device is successfully retrieved.", "example": { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string", "sd_onboarding_completed": "string", "certificate_ready": "string", "firewall_ready": "string", "nat_ready": "string", "security_log_ready": "string" } } ] }, "example": { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string", "sd_onboarding_completed": "string", "certificate_ready": "string", "firewall_ready": "string", "nat_ready": "string", "security_log_ready": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/get_bootstrap_config": { "post": { "tags": [ "Device Onboarding" ], "summary": "GetBootstrapConfig", "description": "Retrieves bootstrap configuration for a device. For MNHA_CLUSTER devices, provide the child device UUID. The response contains Junos set commands as a single string with newline-separated entries. To apply, copy the set commands line by line and remove escape characters if any and load them on the device in configuration mode.", "operationId": "GetBootstrapConfig", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier (UUID) of the device", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body fields for the bootstrap config operation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesGetBootstrapConfigRequest" }, { "description": "Body fields for the bootstrap config operation", "example": { "enable_proxy": true, "routing_instance_configuration": { "standalone": "string", "cluster": { "node0": "string", "node1": "string" } } } } ] }, "example": { "enable_proxy": true, "routing_instance_configuration": { "standalone": "string", "cluster": { "node0": "string", "node1": "string" } } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetBootstrapConfigResponse" }, { "description": "Response containing bootstrap configuration for the requested device", "example": { "bootstrap_config": "string" } } ] }, "example": { "bootstrap_config": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/proxy_server_config": { "get": { "tags": [ "Device Onboarding" ], "summary": "GetProxyServerConfig", "description": "Retrieve the current proxy server configuration.", "operationId": "GetProxyServerConfig", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServerConfig" }, { "description": "Proxy server configuration", "example": { "id": "string", "name": "string", "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } ] }, "example": { "id": "string", "name": "string", "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Device Onboarding" ], "summary": "SetProxyServerConfig", "description": "Create or update the proxy server configuration. If a configuration already exists, it will be replaced.", "operationId": "SetProxyServerConfig", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServerConfigInput" }, { "example": { "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } ] }, "example": { "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServerConfig" }, { "description": "Proxy server configuration", "example": { "id": "string", "name": "string", "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } ] }, "example": { "id": "string", "name": "string", "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/create": { "post": { "tags": [ "Device Onboarding" ], "summary": "BulkCreateDevice", "description": "Onboard devices in batch. Accepts a mixed list of ZTP and BROWN_FIELD devices.", "operationId": "BulkCreateDevice", "parameters": [], "requestBody": { "description": "Unified device onboarding request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesCreateRequest" }, { "description": "Unified device onboarding request.", "example": { "ipv6": true, "devices": [ { "onboarding_type": "BROWN_FIELD", "serial_number": "string", "root_pwd": "string", "type": "STANDALONE", "device_count": 1 } ] } } ] }, "example": { "ipv6": true, "devices": [ { "onboarding_type": "BROWN_FIELD", "serial_number": "string", "root_pwd": "string", "type": "STANDALONE", "device_count": 1 } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkCreateDeviceResponse" }, { "description": "Batch device onboarding response with per-device status", "example": { "status": "FAILURE", "devices": [ { "uuid": "string", "serial_number": "string", "parent_id": "string", "status": "FAILURE", "message": "string", "device_type": "STANDALONE" } ] } } ] }, "example": { "status": "FAILURE", "devices": [ { "uuid": "string", "serial_number": "string", "parent_id": "string", "status": "FAILURE", "message": "string", "device_type": "STANDALONE" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/remove": { "post": { "tags": [ "Device Onboarding" ], "summary": "BulkRemoveDevices", "description": "Remove one or more devices in batch. This is an asynchronous operation that returns a remove_id for tracking the status of the remove device operation.", "operationId": "BulkRemoveDevices", "parameters": [], "requestBody": { "description": "Request to remove devices in batch", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesRemoveRequest" }, { "description": "Request to remove devices in batch", "example": { "uuids": [ "string" ] } } ] }, "example": { "uuids": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkRemoveDevicesResponse" }, { "description": "Response containing the remove device operation ID", "example": { "remove_id": "string" } } ] }, "example": { "remove_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/remove/{remove_id}": { "get": { "tags": [ "Device Onboarding" ], "summary": "GetRemoveDeviceStatus", "description": "Retrieve the status and results of an asynchronous remove device operation using the remove_id returned by BulkRemoveDevices.", "operationId": "GetRemoveDeviceStatus", "parameters": [ { "name": "remove_id", "in": "path", "description": "Unique identifier of the remove device operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRemoveDeviceStatusResponse" }, { "description": "Response containing remove device operation status and results", "example": { "status": "FAILURE", "remove_device_status": [ { "name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "remove_device_status": [ { "name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/licenses": { "get": { "tags": [ "License and Certificate Management" ], "summary": "ListLicenses", "description": "Retrieve a paginated list of licenses installed on a specific device identified by device UUID.", "operationId": "ListLicenses", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device whose licenses are being retrieved", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based)", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListLicensesResponse" }, { "description": "Response containing a paginated list of licenses for a device", "example": { "items": [ { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/licenses/{license_uuid}": { "get": { "tags": [ "License and Certificate Management" ], "summary": "GetLicense", "description": "Retrieve a specific license installed on a device by device UUID and license UUID. Returns license details including state, validity, and dates.", "operationId": "GetLicense", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device", "required": true, "schema": { "type": "string" } }, { "name": "license_uuid", "in": "path", "description": "Unique identifier of the license", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/License" }, { "description": "License represents a license resource installed on a device.", "example": { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } } ] }, "example": { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/ca_certificates": { "get": { "tags": [ "License and Certificate Management" ], "summary": "ListCaCertificates", "description": "Retrieve a list of CA certificates installed on devices.", "operationId": "ListCaCertificates", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListCaCertificatesResponse" }, { "description": "Response containing the list of CA certificates installed on devices", "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/delete_certificate/{delete_certificate_id}": { "get": { "tags": [ "License and Certificate Management" ], "summary": "GetDeleteCertificateStatus", "description": "Retrieve the status and results of an asynchronous delete certificate operation using the delete_certificate_id returned by DeleteCertificate.", "operationId": "GetDeleteCertificateStatus", "parameters": [ { "name": "delete_certificate_id", "in": "path", "description": "Unique identifier of the delete certificate job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeleteCertificateStatusResponse" }, { "description": "Response containing delete certificate job status and details", "example": { "status": "FAILURE", "message": "string" } } ] }, "example": { "status": "FAILURE", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/install_ca_certificate/{install_ca_certificate_id}": { "get": { "tags": [ "License and Certificate Management" ], "summary": "GetInstallCaCertificateStatus", "description": "Retrieve the status and results of an asynchronous install CA certificate operation using the install_ca_certificate_id returned by InstallCaCertificate.", "operationId": "GetInstallCaCertificateStatus", "parameters": [ { "name": "install_ca_certificate_id", "in": "path", "description": "Unique identifier of the CA certificate installation job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetInstallCaCertificateStatusResponse" }, { "description": "Response containing CA certificate installation job status and details", "example": { "status": "FAILURE", "message": "string" } } ] }, "example": { "status": "FAILURE", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/install_license/{install_license_id}": { "get": { "tags": [ "License and Certificate Management" ], "summary": "GetInstallLicenseStatus", "description": "Retrieve the status and results of an asynchronous install license operation using the install_license_id returned by InstallLicense.", "operationId": "GetInstallLicenseStatus", "parameters": [ { "name": "install_license_id", "in": "path", "description": "Unique identifier of the license installation job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetInstallLicenseStatusResponse" }, { "description": "Response containing license installation job status and details", "example": { "status": "FAILURE", "message": "string" } } ] }, "example": { "status": "FAILURE", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/install_local_certificate/{install_local_certificate_id}": { "get": { "tags": [ "License and Certificate Management" ], "summary": "GetInstallLocalCertificateStatus", "description": "Retrieve the status and results of an asynchronous install local certificate operation using the install_local_certificate_id returned by InstallLocalCertificate.", "operationId": "GetInstallLocalCertificateStatus", "parameters": [ { "name": "install_local_certificate_id", "in": "path", "description": "Unique identifier of the local certificate installation job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetInstallLocalCertificateStatusResponse" }, { "description": "Response containing local certificate installation job status and details", "example": { "status": "FAILURE", "message": "string" } } ] }, "example": { "status": "FAILURE", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/local_certificates": { "get": { "tags": [ "License and Certificate Management" ], "summary": "ListLocalCertificates", "description": "Retrieve a list of local certificates installed on devices.", "operationId": "ListLocalCertificates", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListLocalCertificatesResponse" }, { "description": "Response containing the list of local certificates installed on devices", "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/ca_certificates": { "get": { "tags": [ "License and Certificate Management" ], "summary": "ListDeviceCaCertificates", "description": "Retrieve a list of CA certificates installed on a specific device identified by device UUID.", "operationId": "ListDeviceCaCertificates", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device whose CA certificates are being retrieved", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: (name contains my-cert).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDeviceCaCertificatesResponse" }, { "description": "Response containing the list of CA certificates installed on the specified device", "example": { "items": [ { "uuid": "string", "name": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/delete_certificate": { "post": { "tags": [ "License and Certificate Management" ], "summary": "DeleteCertificate", "description": "Delete a local or CA certificate from the specified device. This is an asynchronous operation that returns a delete_certificate_id for tracking the status of the delete certificate operation.", "operationId": "DeleteCertificate", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device from which the certificate will be deleted", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body fields for the delete certificate operation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesDeleteCertificateRequest" }, { "description": "Body fields for the delete certificate operation", "example": { "name": "string", "type": "CA" } } ] }, "example": { "name": "string", "type": "CA" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteCertificateResponse" }, { "description": "Response containing delete certificate job ID for tracking", "example": { "delete_certificate_id": "string" } } ] }, "example": { "delete_certificate_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/install_ca_certificate": { "post": { "tags": [ "License and Certificate Management" ], "summary": "InstallCaCertificate", "description": "Upload and deploy a CA certificate file to the specified device. This is an asynchronous operation that returns an install_ca_certificate_id for tracking the status of the install CA certificate operation and the endpoint expects multipart/form-data with the CA certificate file in the 'ca_certificate' form field. Before fetching the updated certificate list, ensure the device transitions to out-of-sync and then returns to in-sync state.", "operationId": "InstallCaCertificate", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device where the CA certificate will be installed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "ca_certificate", "ca_profile_id" ], "type": "object", "properties": { "ca_certificate": { "type": "string", "description": "CA certificate file to be installed on the device. For REST API: upload as multipart/form-data in ca_certificate form field.", "format": "binary" }, "ca_profile_id": { "type": "string", "description": "Unique identifier of the CA profile to associate with the installed certificate.", "example": "string" } } } } }, "required": false }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InstallCaCertificateResponse" }, { "description": "Response containing install CA certificate job ID for tracking", "example": { "install_ca_certificate_id": "string" } } ] }, "example": { "install_ca_certificate_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/install_license": { "post": { "tags": [ "License and Certificate Management" ], "summary": "InstallLicense", "description": "Upload and deploy a license file to the specified device. This is an asynchronous operation that returns an install_license_id for tracking the status of the install license operation and the endpoint expects multipart/form-data with the license file in the 'license_file' form field. Before fetching the updated license list, ensure the device transitions to out-of-sync and then returns to in-sync state.", "operationId": "InstallLicense", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device where the license will be installed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "type": "object", "properties": { "license_file": { "type": "string", "description": "Txt file containing License information for standalone device. For REST API: upload as multipart/form-data in license_file form field.", "format": "binary" }, "secondary_license_file": { "type": "string", "description": "Txt file containing License information for secondary device in l2_cluster. For REST API: upload as multipart/form-data in secondary_license_file form field.", "format": "binary" } } } } }, "required": false }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InstallLicenseResponse" }, { "description": "Response containing install license job ID for tracking", "example": { "install_license_id": "string" } } ] }, "example": { "install_license_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/install_local_certificate": { "post": { "tags": [ "License and Certificate Management" ], "summary": "InstallLocalCertificate", "description": "Upload and deploy a local certificate to the specified device. This is an asynchronous operation that returns an install_local_certificate_id for tracking the status of the install local certificate operation and the endpoint expects multipart/form-data with the certificate file in the 'local_certificate' form field and the key file in the 'local_certificate_key_file' form field. Before fetching the updated certificate list, ensure the device transitions to out-of-sync and then returns to in-sync state.", "operationId": "InstallLocalCertificate", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device where the local certificate will be installed", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "certificate_id", "local_certificate", "local_certificate_key_file", "pass_phrase" ], "type": "object", "properties": { "certificate_id": { "type": "string", "description": "Unique identifier of the certificate to associate with the installed local certificate.", "example": "string" }, "local_certificate": { "type": "string", "description": "Local certificate file to be installed on the device. For REST API: upload as multipart/form-data in local_certificate form field.", "format": "binary" }, "local_certificate_key_file": { "type": "string", "description": "Private key file corresponding to the local certificate. For REST API: upload as multipart/form-data in local_certificate_key_file form field.", "format": "binary" }, "pass_phrase": { "type": "string", "description": "Pass phrase used to encrypt/decrypt the private key file.", "example": "string" } } } } }, "required": false }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/InstallLocalCertificateResponse" }, { "description": "Response containing install local certificate job ID for tracking", "example": { "install_local_certificate_id": "string" } } ] }, "example": { "install_local_certificate_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/local_certificates": { "get": { "tags": [ "License and Certificate Management" ], "summary": "ListDeviceLocalCertificates", "description": "Retrieve a list of local certificates installed on a specific device identified by device UUID.", "operationId": "ListDeviceLocalCertificates", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device whose local certificates are being retrieved", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: (name contains my-cert).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDeviceLocalCertificatesResponse" }, { "description": "Response containing the list of local certificates installed on the specified device", "example": { "items": [ { "uuid": "string", "name": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_groups": { "get": { "tags": [ "Device Groups" ], "summary": "ListDeviceGroups", "description": "Retrieve a paginated list of device groups with optional filtering and sorting.", "operationId": "ListDeviceGroups", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDeviceGroupsResponse" }, { "description": "ListDeviceGroupsResponse represents the response containing a list of device groups.\nIt also includes metadata such as the total count of device groups matching the query.", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Device Groups" ], "summary": "CreateDeviceGroup", "description": "Create a new device group. Validates the device group data and creates a new device group in the system.", "operationId": "CreateDeviceGroup", "parameters": [], "requestBody": { "description": "CreateDeviceGroupRequest represents a request to create a new device group.\nIt contains the device group details to be created.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceGroup" }, { "description": "CreateDeviceGroupRequest represents a request to create a new device group.\nIt contains the device group details to be created.", "example": { "name": "string", "description": "string", "devices": [ { "device_uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "devices": [ { "device_uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDeviceGroupResponse" }, { "description": "CreateDeviceGroupResponse represents the response after creating a device group.\nIt contains the UUID of the created device group and a result message.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_groups/{uuid}": { "get": { "tags": [ "Device Groups" ], "summary": "GetDeviceGroup", "description": "Retrieve a single device group by its UUID.", "operationId": "GetDeviceGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of the device group to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceGroupResponse" }, { "description": "GetDeviceGroupResponse represents the response containing a single device group's information.\nIt includes the essential details of the requested device group.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Device Groups" ], "summary": "DeleteDeviceGroup", "description": "Delete one or more device groups by their UUIDs. Removes the specified device groups from the system.", "operationId": "DeleteDeviceGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier of the device group to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteDeviceGroupsResponse" }, { "description": "DeleteDeviceGroupsResponse represents the response after deleting device group.\nIt contains the status and a message about the delete operation.", "example": { "uuid": "string" } } ] }, "example": { "uuid": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Device Groups" ], "summary": "UpdateDeviceGroup", "description": "Update an existing device group. Modifies the device group information including name, description, and associated devices.", "operationId": "UpdateDeviceGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "The unique identifier for the device group.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDeviceGroupRequest" }, { "example": { "name": "string", "description": "string", "devices": [ { "device_uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "devices": [ { "device_uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDeviceGroupResponse" }, { "description": "UpdateDeviceGroupResponse represents the response after updating a device group.\nIt contains the UUID of the updated device group and a result message.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/config/rollback/{config_rollback_id}": { "get": { "tags": [ "Device Operations" ], "summary": "GetRollbackConfigVersionStatus", "description": "Retrieve the status and results of an asynchronous rollback config version operation using the config_rollback_id returned by RollbackConfigVersion.", "operationId": "GetRollbackConfigVersionStatus", "parameters": [ { "name": "config_rollback_id", "in": "path", "description": "Unique identifier of the configuration rollback operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRollbackConfigVersionStatusResponse" }, { "description": "Response containing configuration rollback operation status and details", "example": { "status": "FAILURE", "message": "string", "device_uuid": "string" } } ] }, "example": { "status": "FAILURE", "message": "string", "device_uuid": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/reboot": { "post": { "tags": [ "Device Operations" ], "summary": "BulkRebootDevices", "description": "Reboot one or more devices in batch. This is an asynchronous operation that returns a reboot_id for tracking the status of the reboot device operation.", "operationId": "BulkRebootDevices", "parameters": [], "requestBody": { "description": "Request containing array of device UUIDs for reboot operation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesRebootRequest" }, { "description": "Request containing array of device UUIDs for reboot operation.", "example": { "uuids": [ "string" ] } } ] }, "example": { "uuids": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RebootDevicesResponse" }, { "description": "Response containing reboot operation ID", "example": { "reboot_id": "string" } } ] }, "example": { "reboot_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/reboot/{reboot_id}": { "get": { "tags": [ "Device Operations" ], "summary": "GetRebootStatus", "description": "Retrieve the status and results of an asynchronous reboot device operation using the reboot_id returned by BulkRebootDevices.", "operationId": "GetRebootStatus", "parameters": [ { "name": "reboot_id", "in": "path", "description": "Unique identifier of the reboot operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRebootStatusResponse" }, { "description": "Response containing reboot operation status and device results", "example": { "status": "FAILURE", "device_reboot_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "device_reboot_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/sync": { "post": { "tags": [ "Device Operations" ], "summary": "BulkSyncDevices", "description": "Synchronize one or more devices with the network in batch. This is an asynchronous operation that returns a sync_id for tracking the status of the sync device operation.", "operationId": "BulkSyncDevices", "parameters": [], "requestBody": { "description": "Request containing array of device UUIDs for bulk operations.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesSyncRequest" }, { "description": "Request containing array of device UUIDs for bulk operations.", "example": { "uuids": [ "string" ] } } ] }, "example": { "uuids": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SyncDevicesResponse" }, { "description": "Response containing sync operation ID and status", "example": { "sync_id": "string" } } ] }, "example": { "sync_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/sync/{sync_id}": { "get": { "tags": [ "Device Operations" ], "summary": "GetSyncStatus", "description": "Retrieve the status and results of an asynchronous sync device operation using the sync_id returned by BulkSyncDevices.", "operationId": "GetSyncStatus", "parameters": [ { "name": "sync_id", "in": "path", "description": "Unique identifier of the sync operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetSyncStatusResponse" }, { "description": "Response containing sync operation status and device results", "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/versions": { "get": { "tags": [ "Device Operations" ], "summary": "ListConfigVersions", "description": "List archived configuration versions for a specific device. Returns version details including version number, description, archived timestamp, and revision.", "operationId": "ListConfigVersions", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListConfigVersionsResponse" }, { "description": "Response containing list of configuration versions for a device", "example": { "items": [ { "version_number": "string", "description": "string", "archived_timestamp": "string", "revision": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "version_number": "string", "description": "string", "archived_timestamp": "string", "revision": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/versions/{version_number}/rollback": { "post": { "tags": [ "Device Operations" ], "summary": "RollbackConfigVersion", "description": "Rollback a device configuration to a specified version. This is an asynchronous operation that returns a config_rollback_id for tracking the status of the rollback config version operation.", "operationId": "RollbackConfigVersion", "parameters": [ { "name": "device_uuid", "in": "path", "description": "Unique identifier of the device", "required": true, "schema": { "type": "string" } }, { "name": "version_number", "in": "path", "description": "Configuration version number to rollback to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RollbackConfigVersionResponse" }, { "description": "Response containing rollback operation ID and initiation status", "example": { "config_rollback_id": "string" } } ] }, "example": { "config_rollback_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/idp_sensors": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigIdpSensor", "description": "Get the IDP sensor configuration for a specific device.", "operationId": "GetDeviceConfigIdpSensor", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration zones are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of 50 records.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. (Example: name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigIdpSensorResponse" }, { "description": "Response containing the IDP sensor configuration for a device.", "example": { "items": [ { "packet_log": { "host": { "ipaddr": "string", "port": "string" }, "source_address": "string", "threshold_logging_interval": "string", "max_sessions": { "percentage_value": "string" }, "total_memory": { "percentage_value": "string" } } } ], "count": 1 } } ] }, "example": { "items": [ { "packet_log": { "host": { "ipaddr": "string", "port": "string" }, "source_address": "string", "threshold_logging_interval": "string", "max_sessions": { "percentage_value": "string" }, "total_memory": { "percentage_value": "string" } } } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/interfaces": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigInterface", "description": "Get interfaces for a specific device. Returns interface details with pagination support.", "operationId": "GetDeviceConfigInterface", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration zones are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of 50 records.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. (Example: name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigInterfaceResponse" }, { "description": "Response containing the interfaces for a device.", "example": { "items": [ { "name": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "name": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/interfaces/{interface_name}/subinterfaces": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceInterfaceSubinterfaces", "description": "Get sub-interfaces for a specific interface on a device. The interface name uses underscores in place of forward slashes (e.g. ge-0_0_0 for ge-0/0/0). Returns sub-interface details with pagination support.", "operationId": "GetDeviceInterfaceSubinterfaces", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose interface sub-interfaces are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "interface_name", "in": "path", "description": "Name of the interface, with forward slashes replaced by underscores (e.g. ge-0_0_0 for ge-0/0/0).", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. Example: (name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigSubInterfaceResponse" }, { "description": "Response containing the sub-interfaces for a device interface.", "example": { "items": [ { "name": "string", "address": [ { "name": "string" } ] } ], "count": 1 } } ] }, "example": { "items": [ { "name": "string", "address": [ { "name": "string" } ] } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/latest_version": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigRevisions", "description": "Get the configuration revision and last sync revision for a specific device.", "operationId": "GetDeviceConfigRevisions", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration revision status is being retrieved.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigRevisionsResponse" }, { "description": "Response containing the configuration revision status for a device.", "example": { "device_config_revision": "string", "last_sync_revision": "string" } } ] }, "example": { "device_config_revision": "string", "last_sync_revision": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/routing_instances": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigRI", "description": "Get routing instances for a specific device. Returns routing instance details with pagination support.", "operationId": "GetDeviceConfigRI", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration zones are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of 50 records.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. (Example: name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigRIResponse" }, { "description": "Response containing the routing instances for a device.", "example": { "items": [ { "name": "string", "instance_type": "string", "interface": [ { "name": "string" } ] } ], "count": 1 } } ] }, "example": { "items": [ { "name": "string", "instance_type": "string", "interface": [ { "name": "string" } ] } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/subinterfaces": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigSubInterface", "description": "Get sub-interfaces for a specific interface on a device. Returns sub-interface details with pagination support.", "operationId": "GetDeviceConfigSubInterface", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration zones are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of 50 records.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. (Example: name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigSubInterfaceResponse" }, { "description": "Response containing the sub-interfaces for a device interface.", "example": { "items": [ { "name": "string", "address": [ { "name": "string" } ] } ], "count": 1 } } ] }, "example": { "items": [ { "name": "string", "address": [ { "name": "string" } ] } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_uuid}/config/zones": { "get": { "tags": [ "Device Resources" ], "summary": "GetDeviceConfigZones", "description": "Get configuration zones for a specific device. Returns zone details with pagination support.", "operationId": "GetDeviceConfigZones", "parameters": [ { "name": "device_uuid", "in": "path", "description": "UUID of the device whose configuration zones are being retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, defaults to 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of 50 records.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "filter", "in": "query", "description": "Filter conditions to apply to the results. (Example: name contains trust)", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeviceConfigZonesResponse" }, { "description": "Response containing the configuration zones for a device.", "example": { "items": [ { "name": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "name": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/mnha_clusters/sync/{mnha_sync_id}": { "get": { "tags": [ "MNHA Clusters" ], "summary": "GetSyncMNHAStatus", "description": "Retrieve the status and results of an asynchronous sync MNHA device operation using the mnha_sync_id returned by SyncMnhaDevices.", "operationId": "GetSyncMNHAStatus", "parameters": [ { "name": "mnha_sync_id", "in": "path", "description": "Unique identifier of the MNHA sync operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMnhaSyncStatusResponse" }, { "description": "Response containing MNHA sync operation status and device results", "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/mnha_clusters/{mnha_cluster_id}/sync": { "post": { "tags": [ "MNHA Clusters" ], "summary": "SyncMnhaDevices", "description": "Synchronize MNHA devices with the network. This is an asynchronous operation that returns a mnha_sync_id for tracking the status of the sync MNHA device operation. This API operates on MNHA child UUIDs and fetches latest configuration and state.", "operationId": "SyncMnhaDevices", "parameters": [ { "name": "mnha_cluster_id", "in": "path", "description": "Unique identifier of the MNHA cluster to synchronize", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SyncMnhaDevicesResponse" }, { "description": "Response containing MNHA sync operation ID for tracking the operation", "example": { "mnha_sync_id": "string" } } ] }, "example": { "mnha_sync_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates": { "get": { "tags": [ "Templates" ], "summary": "ListTemplates", "description": "Fetches multiple templates from the system with support for pagination, filtering, and ordering capabilities. Example: GET /v1/templates?limit=20&start=0. Returns paginated list of configuration templates with metadata including total count. Throws 400 for invalid filter or pagination parameters. Retrieve a paginated list of templates with optional filtering and sorting.", "operationId": "ListTemplates", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListTemplatesResponse" }, { "description": "ListTemplatesResponse represents the response containing a list of configuration templates.\nIt also includes metadata such as the total count of templates matching the query.", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "format": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "format": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/deploy/{deploy_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplateDeployStatus", "description": "Retrieve template deployment status and details by deployment ID. Fetches deployment progress and outcome details.", "operationId": "GetTemplateDeployStatus", "parameters": [ { "name": "deploy_id", "in": "path", "description": "deploy_id is the unique identifier of the template deployment operation.\nThis field is required and must be a valid UUID string returned from DeployTemplate.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeployStatusResponse" }, { "description": "GetDeployStatusResponse contains the deployment status and results for all target devices.\nIncludes the deployed configuration and status for each device.", "example": { "status": "string", "template_id": "string", "template_name": "string", "message": "string", "device_deploy_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ] } } ] }, "example": { "status": "string", "template_id": "string", "template_name": "string", "message": "string", "device_deploy_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/deploy/{deploy_id}/devices/{device_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplateDeployResultByDevice", "description": "Retrieve device-specific template deployment result by deployment ID and device ID. Fetches the deployment result for a single device from a previous deployment operation. Note: device_id here refers to the UUID of the individual device. MNHA parent ID is not supported. Use one of the UUIDs from the device_deploy_status array in the GetTemplateDeployStatus response.", "operationId": "GetTemplateDeployResultByDevice", "parameters": [ { "name": "deploy_id", "in": "path", "description": "deploy_id is the unique identifier of the template deployment operation.\nThis field is required and must be a valid UUID string returned from DeployTemplate.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device to retrieve deployment result for.\nThis field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeployResultByDeviceResponse" }, { "description": "GetDeployResultByDeviceResponse contains the deployment result for a specific device.\nReturns the device-specific deployment result including deployed configuration and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "deployed_config": "string", "message": "string" } } ] }, "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "deployed_config": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/preview/{preview_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplatePreviewStatus", "description": "Retrieve template preview results by preview ID. Fetches the generated configuration preview from a previous preview operation.", "operationId": "GetTemplatePreviewStatus", "parameters": [ { "name": "preview_id", "in": "path", "description": "preview_id is the unique identifier of the template preview operation.\nThis field is required and must be a valid UUID string returned from PreviewTemplate.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPreviewStatusResponse" }, { "description": "GetPreviewStatusResponse contains the configuration preview results for all target devices.\nIncludes the generated configuration diff for each device along with status information.", "example": { "status": "string", "template_id": "string", "template_name": "string", "device_preview_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } } ] }, "example": { "status": "string", "template_id": "string", "template_name": "string", "device_preview_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/preview/{preview_id}/devices/{device_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplatePreviewResultByDevice", "description": "Retrieve device-specific template preview result by preview ID and device ID. Fetches the generated configuration preview for a single device from a previous preview operation. Note: device_id here refers to the UUID of the individual device. MNHA parent ID is not supported. Use one of the UUIDs from the device_preview_status array in the GetTemplatePreviewStatus response.", "operationId": "GetTemplatePreviewResultByDevice", "parameters": [ { "name": "preview_id", "in": "path", "description": "preview_id is the unique identifier of the template preview operation.\nThis field is required and must be a valid UUID string returned from PreviewTemplate.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device to retrieve preview result for.\nThis field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPreviewResultByDeviceResponse" }, { "description": "GetPreviewResultByDeviceResponse contains the preview result for a specific device.\nReturns the device-specific preview result including configuration diff and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "config_diff": "string", "message": "string" } } ] }, "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "config_diff": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/validate/{validate_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplateValidateStatus", "description": "Retrieve template validation results by validation ID. Fetches validation status and any errors or warnings found.", "operationId": "GetTemplateValidateStatus", "parameters": [ { "name": "validate_id", "in": "path", "description": "validate_id is the unique identifier of the template validation operation.\nThis field is required and must be a valid UUID string returned from ValidateTemplate.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetValidateStatusResponse" }, { "description": "GetValidateStatusResponse contains the validation results for all target devices.\nIncludes validation status and any errors found for each device.", "example": { "status": "string", "template_id": "string", "template_name": "string", "device_validate_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } } ] }, "example": { "status": "string", "template_id": "string", "template_name": "string", "device_validate_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/validate/{validate_id}/devices/{device_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplateValidateResultByDevice", "description": "Retrieve device-specific template validation result by validation ID and device ID. Fetches the validation result for a single device from a previous validation operation. Note: device_id here refers to the UUID of the individual device. MNHA parent ID is not supported. Use one of the UUIDs from the device_validate_status array in the GetTemplateValidateStatus response.", "operationId": "GetTemplateValidateResultByDevice", "parameters": [ { "name": "validate_id", "in": "path", "description": "validate_id is the unique identifier of the template validation operation.\nThis field is required and must be a valid UUID string returned from ValidateTemplate.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device to retrieve validation result for.\nThis field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetValidateResultByDeviceResponse" }, { "description": "GetValidateResultByDeviceResponse contains the validation result for a specific device.\nReturns the device-specific validation result including validated configuration and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "validated_config": "string", "message": "string" } } ] }, "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "validated_config": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/workflow_definitions": { "post": { "tags": [ "Templates" ], "summary": "UploadTemplateDefinition", "description": "Upload a YAML file containing workflow definition for creating or updating a template. Note: This endpoint expects multipart/form-data with the YAML file in the 'definition_file' form field.", "operationId": "UploadTemplateDefinition", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "definition_file" ], "type": "object", "properties": { "definition_file": { "type": "string", "description": "YAML file containing workflow definition", "format": "binary" } } } } }, "required": false }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkflowDefinitionUploadResponse" }, { "description": "WorkflowDefinitionUploadResponse represents the response for workflow definition upload.", "example": { "status": "string", "resource_type": "string", "resource_id": "string", "message": "string" } } ] }, "example": { "status": "string", "resource_type": "string", "resource_id": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplate", "description": "Retrieve a single template by its UUID.", "operationId": "GetTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "The unique identifier of the configuration template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTemplateResponse" }, { "description": "GetTemplateResponse represents the response containing a single configuration template's information.\nIt includes the essential details of the requested configuration template.", "example": { "uuid": "string", "name": "string", "description": "string", "format": "string", "template": "string", "variablesdef": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "format": "string", "template": "string", "variablesdef": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Templates" ], "summary": "DeleteTemplate", "description": "Delete a configuration template permanently. Removes template and associated variable definitions from the system.", "operationId": "DeleteTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to delete.\nThis field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteTemplateResponse" }, { "description": "DeleteTemplateResponse contains the result of deleted configuration template.\nProvides individual results for each template deletion attempt.", "example": { "status": "string", "message": "string", "template_id": "string", "template_name": "string" } } ] }, "example": { "status": "string", "message": "string", "template_id": "string", "template_name": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/csv/download": { "post": { "tags": [ "Templates" ], "summary": "DownloadCSVTemplate", "description": "Generate and download a CSV template file containing device parameter mappings for a configuration template. The CSV includes columns for device identifiers and all template variables. Optionally filter by specific device UUIDs. Returns a pre-signed URL for downloading the generated CSV file.", "operationId": "DownloadCSVTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "UUID of the configuration template for which to download the CSV template", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CSVTemplateDownloadRequest" }, { "example": { "device_uuids": [ "string" ] } } ] }, "example": { "device_uuids": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CSVTemplateDownloadResponse" }, { "description": "CSVTemplateDownloadResponse represents the response for CSV template download.", "example": { "status": "string", "signed_url": "string", "error_message": "string", "file_name": "string" } } ] }, "example": { "status": "string", "signed_url": "string", "error_message": "string", "file_name": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/csv/upload": { "post": { "tags": [ "Templates" ], "summary": "UploadCSVTemplate", "description": "Upload a CSV file containing device parameter mappings for template deployment. Note: This endpoint expects multipart/form-data with the CSV file in the 'device_params_file' form field", "operationId": "UploadCSVTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "The unique identifier of the configuration template", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "encoding": {}, "schema": { "required": [ "device_params_file" ], "type": "object", "properties": { "device_params_file": { "type": "string", "description": "CSV file containing device parameter mappings", "format": "binary" } } } } }, "required": false }, "responses": { "200": { "description": "A successful response containing the device information", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1TemplatesCsvUploadResponse" }, { "example": { "status": "string", "message": "string", "associations": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ], "template_name": "string", "template_id": "string" } } ] }, "example": { "status": "string", "message": "string", "associations": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ], "template_name": "string", "template_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/deploy": { "post": { "tags": [ "Templates" ], "summary": "DeployTemplate", "description": "Deploy a configuration template to target devices. Applies template configuration using specified parameters and device mappings.", "operationId": "DeployTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to associate parameters with. This field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployTemplateRequest" }, { "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } } ] }, "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployTemplateResponse" }, { "description": "DeployTemplateResponse contains the result of initiating a template deployment.\nProvides job identifiers for tracking the deployment progress and status.", "example": { "deploy_id": "string", "status": "string", "message": "string", "scheduled_deploy_id": "string" } } ] }, "example": { "deploy_id": "string", "status": "string", "message": "string", "scheduled_deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/mappings/batch": { "post": { "tags": [ "Templates" ], "summary": "BulkSaveTemplateMappings", "description": "Save parameter mappings for a configuration template. Associates template variables with device-specific values for deployment. Note: If any changes done to the device groups. User has to UPDATE Template Mappings again", "operationId": "BulkSaveTemplateMappings", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to associate parameters with. This field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SaveTemplateMappingsRequest" }, { "example": { "global_params": { "example": "string" }, "operations": [ { "action": "CREATE", "params": { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } } ] } } ] }, "example": { "global_params": { "example": "string" }, "operations": [ { "action": "CREATE", "params": { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SaveTemplateMappingsResponse" }, { "description": "SaveTemplateMappingsResponse contains the result of saving template-device parameter mappings.\nThis response indicates whether the mappings were successfully saved and provides details for each device.", "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } } ] }, "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/mappings/devices": { "get": { "tags": [ "Templates" ], "summary": "ListTemplateMappings", "description": "List all device parameter mappings for a configuration template. Retrieves all device and device-group mappings.", "operationId": "ListTemplateMappings", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to list device mappings for.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If not provided, the default is 2000.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 50 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: (name contains vsrx).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "When true, returns only the total count of matching resources without resource details.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListTemplateMappingsResponse" }, { "description": "ListTemplateMappingsResponse contains the list of all device mappings for a template.\nReturns all device and device-group mappings with their parameter values.", "example": { "items": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ], "count": 1 } } ] }, "example": { "items": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/mappings/devices/{device_id}": { "get": { "tags": [ "Templates" ], "summary": "GetTemplateMapping", "description": "Retrieve a single device parameter mapping for a configuration template. Fetches parameter values for a specific device or device-group.", "operationId": "GetTemplateMapping", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device or device-group.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetTemplateMappingResponse" }, { "description": "GetTemplateMappingResponse contains a single device mapping with its parameter values.", "example": { "mappings": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ] } } ] }, "example": { "mappings": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Templates" ], "summary": "DeleteTemplateMapping", "description": "Delete a device parameter mapping from a configuration template. Removes the mapping between a device and template.", "operationId": "DeleteTemplateMapping", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device to remove mapping for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeleteTemplateMappingResponse" }, { "description": "DeleteTemplateMappingResponse contains the result of deleting a device mapping.", "example": { "status": "string", "message": "string", "device_id": "string", "template_id": "string", "template_name": "string" } } ] }, "example": { "status": "string", "message": "string", "device_id": "string", "template_id": "string", "template_name": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Templates" ], "summary": "UpdateTemplateMapping", "description": "Update parameter values for a specific device mapping. Modifies the parameter payload for a single device", "operationId": "UpdateTemplateMapping", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to associate parameters with. This field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "device_id is the unique identifier of the device.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTemplateMappingRequest" }, { "example": { "payload": { "example": "string" } } } ] }, "example": { "payload": { "example": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateTemplateMappingResponse" }, { "description": "UpdateTemplateMappingResponse contains the result of updating a device mapping.", "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } } ] }, "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/preview": { "post": { "tags": [ "Templates" ], "summary": "PreviewTemplate", "description": "Generate a preview of template configuration output. Shows the rendered configuration without deploying to devices.", "operationId": "PreviewTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to associate parameters with. This field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewTemplateRequest" }, { "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } }, "format": "XML" } } ] }, "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } }, "format": "XML" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewTemplateResponse" }, { "description": "PreviewTemplateResponse contains the result of initiating a template preview generation.\nProvides a job identifier for retrieving the generated configuration preview.", "example": { "preview_id": "string", "status": "string", "message": "string" } } ] }, "example": { "preview_id": "string", "status": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/templates/{template_id}/validate": { "post": { "tags": [ "Templates" ], "summary": "ValidateTemplate", "description": "Validate template performs a commit check after loading the configuration to the device and returns any runtime errors found in the configuration. Note: For device-specific validation results, use GetTemplateValidateResultByDevice with individual device UUIDs from the device_validate_status array.", "operationId": "ValidateTemplate", "parameters": [ { "name": "template_id", "in": "path", "description": "template_id is the unique identifier of the template to associate parameters with. This field is required and must be a valid UUID string.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateTemplateRequest" }, { "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } } ] }, "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ValidateTemplateResponse" }, { "description": "ValidateTemplateResponse contains the result of initiating a template validation.\nProvides a job identifier for retrieving validation results and template information.", "example": { "validate_id": "string", "status": "string", "message": "string", "template_id": "string", "template_name": "string" } } ] }, "example": { "validate_id": "string", "status": "string", "message": "string", "template_id": "string", "template_name": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/rma/reactivate/{reactivation_id}": { "get": { "tags": [ "RMA" ], "summary": "GetReactivationStatus", "description": "Poll the per-step progress of a reactivation or bulk upload-and-install job using the reactivation_id returned by ReactivateRMADeviceV1.", "operationId": "GetReactivationStatus", "parameters": [ { "name": "reactivation_id", "in": "path", "description": "Unique identifier (UUID) of the reactivation operation. Obtained from ReactivateRMADeviceV1 response.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetReactivationStatusResponse" }, { "description": "Detailed status information for an RMA reactivation including step-by-step execution details and overall status.", "example": { "status": "string", "steps": [ { "description": "string", "status": "string", "status_message": "string" } ] } } ] }, "example": { "status": "string", "steps": [ { "description": "string", "status": "string", "status_message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_id}/rma/activate": { "post": { "tags": [ "RMA" ], "summary": "PutDeviceInRMA", "description": "Put a Single device into RMA state in Security Director", "operationId": "PutDeviceInRMA", "parameters": [ { "name": "device_id", "in": "path", "description": "Unique identifier (UUID) of the device. Device must be in UP or DOWN management state to be eligible for RMA.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PutDeviceInRMAResponse" }, { "description": "Response after putting a single device into RMA state, containing request data and operation result.", "example": { "device_id": "string", "host_name": "string", "message": "string" } } ] }, "example": { "device_id": "string", "host_name": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_id}/rma/reactivate": { "post": { "tags": [ "RMA" ], "summary": "ReactivateRMADevice", "description": "Reactivates a failed RMA job, or uploads and installs certificates/licenses for a device in RMA state. Send an empty body to retry a failed reactivation or discovery job. Include certificate/license data in the body to upload and install them on the device, then auto-trigger reactivation.", "operationId": "ReactivateRMADevice", "parameters": [ { "name": "device_id", "in": "path", "description": "Unique identifier (UUID) of the device in RMA state.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional body. When populated with certificate/license data, routes to the\nbulk upload and install workflow. When absent, retries a failed reactivation\nor discovery job.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DevicesRmaReactivateRequest" }, { "description": "Optional body. When populated with certificate/license data, routes to the\nbulk upload and install workflow. When absent, retries a failed reactivation\nor discovery job.", "example": { "ca_certificates": [ { "id": "string", "certificate_contents": "string", "ignore": true } ], "local_certificates": [ { "id": "string", "certificate_contents": "string", "key_contents": "string", "passphrase": "string", "ignore": true } ], "license": { "license_contents": "string", "ignore": true }, "default_ca": { "ignore": true } } } ] }, "example": { "ca_certificates": [ { "id": "string", "certificate_contents": "string", "ignore": true } ], "local_certificates": [ { "id": "string", "certificate_contents": "string", "key_contents": "string", "passphrase": "string", "ignore": true } ], "license": { "license_contents": "string", "ignore": true }, "default_ca": { "ignore": true } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ReactivateRMADeviceResponse" }, { "description": "Response from the reactivate endpoint. A 200 OK always contains a reactivation_id for tracking. Use GetReactivationStatusV1 to poll progress. Error conditions (invalid state, already completed, etc.) return appropriate HTTP error codes.", "example": { "reactivation_id": "string" } } ] }, "example": { "reactivation_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_id}/rma/reactivation_config": { "get": { "tags": [ "RMA" ], "summary": "GetRMAReactivationConfig", "description": "Get the bootstrap reactivation configuration for an RMA device", "operationId": "GetRMAReactivationConfig", "parameters": [ { "name": "device_id", "in": "path", "description": "Unique identifier (UUID) of the device in RMA state. The device must be currently marked as RMA to retrieve reactivation configuration.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRMAReactivationConfigResponse" }, { "description": "Bootstrap reactivation configuration to be applied to the replacement device during RMA reactivation process.", "example": { "reactivation_config": { "config_format": "string", "config_contents": "string" } } } ] }, "example": { "reactivation_config": { "config_format": "string", "config_contents": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_id}/rma/reactivation_preferences": { "post": { "tags": [ "RMA" ], "summary": "SetupRmaDeviceForReactivation", "description": "Option to setup device for reactivation from RMA state in Security Director", "operationId": "SetupRmaDeviceForReactivation", "parameters": [ { "name": "device_id", "in": "path", "description": "Unique identifier (UUID) of the device in RMA state to prepare for reactivation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetupRMADeviceRequest" }, { "example": { "skip_password_from_config": true } } ] }, "example": { "skip_password_from_config": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SetupRMADeviceResponse" }, { "description": "Response after setting up a device for RMA reactivation.", "example": { "message": "string", "state": "string" } } ] }, "example": { "message": "string", "state": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/devices/{device_id}/rma/state": { "get": { "tags": [ "RMA" ], "summary": "GetRMADeviceStatus", "description": "Get detailed status for a specific device, which is in RMA state, including validation failures and missing resources", "operationId": "GetRMADeviceStatus", "parameters": [ { "name": "device_id", "in": "path", "description": "Unique identifier (UUID) of the device to check RMA reactivation status for. Device must be in or have been in RMA state.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRMADeviceStatusResponse" }, { "description": "Detailed RMA reactivation status including current status, failure reasons, and lists of missing resources (certificates, licenses) preventing reactivation.", "example": { "status": "string", "failure_reason": "string", "missing_ca_certificate": [ "string" ], "missing_certificates": [ "string" ], "missing_licenses": [ "string" ] } } ] }, "example": { "status": "string", "failure_reason": "string", "missing_ca_certificate": [ "string" ], "missing_certificates": [ "string" ], "missing_licenses": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/aamw_profiles": { "get": { "tags": [ "AamwProfile" ], "summary": "ListAamwProfile", "description": "List all aamw-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListAamwProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListAamwProfileResponse" }, { "description": "Response containing a list of aamw profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "AamwProfile" ], "summary": "CreateAamwProfile", "description": "Create a new aamw-profile with the provided configuration. Validates input before creation.", "operationId": "CreateAamwProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AamwProfileInput" }, { "example": { "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AamwProfile" }, { "description": "Advanced Anti-Malware (AAMW) profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/aamw_profiles/{uuid}": { "get": { "tags": [ "AamwProfile" ], "summary": "GetAamwProfile", "description": "Retrieve a specific aamw-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetAamwProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the aamw profile to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AamwProfile" }, { "description": "Advanced Anti-Malware (AAMW) profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "AamwProfile" ], "summary": "DeleteAamwProfile", "description": "Delete a specific aamw-profile by ID. Permanently removes the resource.", "operationId": "DeleteAamwProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the aamw profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "AamwProfile" ], "summary": "UpdateAamwProfile", "description": "Update an existing aamw-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateAamwProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the aamw profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AamwProfileInput" }, { "example": { "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AamwProfile" }, { "description": "Advanced Anti-Malware (AAMW) profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/content_filtering_profiles": { "get": { "tags": [ "ContentFilteringProfile" ], "summary": "ListContentFilteringProfile", "description": "List all content-filtering-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListContentFilteringProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListContentFilteringProfileResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "ContentFilteringProfile" ], "summary": "CreateContentFilteringProfile", "description": "Create a new content-filtering-profile with the provided configuration. Validates input before creation.", "operationId": "CreateContentFilteringProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentFilteringProfileInput" }, { "example": { "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } ] }, "example": { "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/content_filtering_profiles/{uuid}": { "get": { "tags": [ "ContentFilteringProfile" ], "summary": "GetContentFilteringProfile", "description": "Retrieve a specific content-filtering-profiles by ID. Fetches detailed information using its unique identifier.", "operationId": "GetContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "ContentFilteringProfile" ], "summary": "DeleteContentFilteringProfile", "description": "Delete a specific content-filtering-profiles by ID. Permanently removes the resource.", "operationId": "DeleteContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "ContentFilteringProfile" ], "summary": "UpdateContentFilteringProfile", "description": "Update an existing content-filtering-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentFilteringProfileInput" }, { "example": { "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } ] }, "example": { "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/content_security_profiles": { "get": { "tags": [ "ContentSecurityProfile" ], "summary": "ListContentSecurityProfile", "description": "List all content-security-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListContentSecurityProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListContentSecurityProfileResponse" }, { "description": "Response containing a list of content security profile profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "ContentSecurityProfile" ], "summary": "CreateContentSecurityProfile", "description": "Create a new content-security-profile with the provided configuration. Validates input before creation.", "operationId": "CreateContentSecurityProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecurityProfileInput" }, { "example": { "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } ] }, "example": { "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecurityProfile" }, { "description": "utm-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/content_security_profiles/{uuid}": { "get": { "tags": [ "ContentSecurityProfile" ], "summary": "GetContentSecurityProfile", "description": "Retrieve a specific content-security-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetContentSecurityProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the content security profile profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecurityProfile" }, { "description": "utm-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "ContentSecurityProfile" ], "summary": "DeleteContentSecurityProfile", "description": "Delete a specific content-security-profile by ID. Permanently removes the resource.", "operationId": "DeleteContentSecurityProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the content security profile profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "ContentSecurityProfile" ], "summary": "UpdateContentSecurityProfile", "description": "Update an existing content-security-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateContentSecurityProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the content security profile profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecurityProfileInput" }, { "example": { "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } ] }, "example": { "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecurityProfile" }, { "description": "utm-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/content_security_settings": { "get": { "tags": [ "ContentSecuritySettings" ], "summary": "GetContentSecuritySettings", "description": "Retrieve the Content Security Settings. This is a singleton resource — only one exists per tenant.", "operationId": "GetContentSecuritySettings", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecuritySettings" }, { "description": "Content Security Settings resource", "example": { "name": "string", "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "ContentSecuritySettings" ], "summary": "UpdateContentSecuritySettings", "description": "Update the Content Security Settings.", "operationId": "UpdateContentSecuritySettings", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecuritySettings" }, { "example": { "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } ] }, "example": { "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ContentSecuritySettings" }, { "description": "Content Security Settings resource", "example": { "name": "string", "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles": { "get": { "tags": [ "EnhancedContentFilteringProfile" ], "summary": "ListEnhancedContentFilteringProfile", "description": "List all enhanced-content-filtering-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListEnhancedContentFilteringProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListEnhancedContentFilteringProfileResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "EnhancedContentFilteringProfile" ], "summary": "CreateEnhancedContentFilteringProfile", "description": "Create a new enhanced-content-filtering-profile with the provided configuration. Validates input before creation.", "operationId": "CreateEnhancedContentFilteringProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileInput" }, { "example": { "name": "string", "description": "string" } } ] }, "example": { "name": "string", "description": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles/{uuid}": { "get": { "tags": [ "EnhancedContentFilteringProfile" ], "summary": "GetEnhancedContentFilteringProfile", "description": "Retrieve a specific enhanced-content-filtering-profiles by ID. Fetches detailed information using its unique identifier.", "operationId": "GetEnhancedContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "EnhancedContentFilteringProfile" ], "summary": "DeleteEnhancedContentFilteringProfile", "description": "Delete a specific enhanced-content-filtering-profiles by ID. Permanently removes the resource.", "operationId": "DeleteEnhancedContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "EnhancedContentFilteringProfile" ], "summary": "UpdateEnhancedContentFilteringProfile", "description": "Update an existing enhanced-content-filtering-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateEnhancedContentFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the resource to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileInput" }, { "example": { "name": "string", "description": "string" } } ] }, "example": { "name": "string", "description": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles/{profile_uuid}/rule_sets": { "get": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "ListEnhancedContentFilteringProfileRuleSet", "description": "List all enhanced-content-filtering-profiles rule-sets based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListEnhancedContentFilteringProfileRuleSet", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Zero-based offset for pagination (default: 0)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of items to return per page (default: 50)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by.\nExample: name(ascending)\n\nField name and direction for sorting, e.g., 'name(ascending)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response (for partial responses). \nExample: fields=uuid && fields=name\n\nComma-separated list of fields to include in the response (sparse fieldset)", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results. \nExample: filters = ((name contains sometext) and (uuid eq dummy-id))\n\nFilter expression to narrow results, e.g., '(name contains foo)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. \nExample: obj_uuids=uuid1 && obj_uuids=uuid2\n\nComma-separated list of specific object UUIDs to retrieve", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "parent_type", "in": "query", "description": "Type of the parent object for filtering child resources", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, return only the count of matching items without the items themselves", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListEnhancedContentFilteringProfileRuleSetResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "CreateEnhancedContentFilteringProfileRuleSet", "description": "Create a new enhanced-content-filtering-profile rule-set with the provided configuration. Validates input before creation.", "operationId": "CreateEnhancedContentFilteringProfileRuleSet", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRuleSetInput" }, { "example": { "name": "string" } } ] }, "example": { "name": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRuleSet" }, { "example": { "uuid": "string", "name": "string" } } ] }, "example": { "uuid": "string", "name": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles/{profile_uuid}/rule_sets/{rule_set_uuid}/rules": { "get": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "ListEnhancedContentFilteringProfileRule", "description": "List all enhanced-content-filtering-profile rules based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListEnhancedContentFilteringProfileRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_set_uuid", "in": "path", "description": "UUID of the parent rule-set", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Zero-based offset for pagination (default: 0)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of items to return per page (default: 50)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by.\nExample: name(ascending)\n\nField name and direction for sorting, e.g., 'name(ascending)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response (for partial responses). \nExample: fields=uuid && fields=name\n\nComma-separated list of fields to include in the response (sparse fieldset)", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results. \nExample: filters = ((name contains sometext) and (uuid eq dummy-id))\n\nFilter expression to narrow results, e.g., '(name contains foo)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. \nExample: obj_uuids=uuid1 && obj_uuids=uuid2\n\nComma-separated list of specific object UUIDs to retrieve", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "parent_type", "in": "query", "description": "Type of the parent object for filtering child resources", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, return only the count of matching items without the items themselves", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListEnhancedContentFilteringProfileRuleResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "CreateEnhancedContentFilteringProfileRule", "description": "Create a new enhanced-content-filtering-profile rule with the provided configuration. Validates input before creation.", "operationId": "CreateEnhancedContentFilteringProfileRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_set_uuid", "in": "path", "description": "UUID of the parent rule-set", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRuleInput" }, { "example": { "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } ] }, "example": { "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRule" }, { "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles/{profile_uuid}/rule_sets/{rule_set_uuid}/rules/{uuid}": { "get": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "GetEnhancedContentFilteringProfileRule", "description": "Get an existing enhanced-content-filtering-profile rule by ID. Supports partial updates with field masks.", "operationId": "GetEnhancedContentFilteringProfileRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_set_uuid", "in": "path", "description": "UUID of the parent rule-set", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "UUID of the rule to update", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRule" }, { "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "DeleteEnhancedContentFilteringProfileRule", "description": "Delete a specific enhanced-content-filtering-profile rule by ID. Permanently removes the resource.", "operationId": "DeleteEnhancedContentFilteringProfileRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_set_uuid", "in": "path", "description": "UUID of the parent rule-set", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "UUID of the rule to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "UpdateEnhancedContentFilteringProfileRule", "description": "Update an existing enhanced-content-filtering-profile rule by ID. Supports partial updates with field masks.", "operationId": "UpdateEnhancedContentFilteringProfileRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_set_uuid", "in": "path", "description": "UUID of the parent rule-set", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "UUID of the rule to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRuleInput" }, { "example": { "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } ] }, "example": { "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRule" }, { "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/enhanced_content_filtering_profiles/{profile_uuid}/rule_sets/{uuid}": { "delete": { "tags": [ "EnhancedContentFilteringProfileSet" ], "summary": "DeleteEnhancedContentFilteringProfileRuleSet", "description": "Delete a specific enhanced-content-filtering-profiles rule-set by ID. Permanently removes the resource.", "operationId": "DeleteEnhancedContentFilteringProfileRuleSet", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent enhanced-content-filtering-profile", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "description": "UUID of the rule-set to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/firewall_device_global_settings": { "get": { "tags": [ "DeviceGlobalSettings" ], "summary": "ListDeviceGlobalSettings", "description": "List device-specific global settings with optional filtering.", "operationId": "ListDeviceGlobalSettings", "parameters": [ { "name": "device_id", "in": "query", "description": "Optional filter by device UUID\n\nOptional: filter by device UUID", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Pagination offset\n\nPagination offset (zero-based)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "Pagination limit\n\nMaximum number of items to return", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDeviceGlobalSettingsResponse" }, { "example": { "items": [ { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "DeviceGlobalSettings" ], "summary": "CreateDeviceGlobalSettings", "description": "Create device-specific global settings. Parent is automatically set to GlobalSettings singleton.", "operationId": "CreateDeviceGlobalSettings", "parameters": [], "requestBody": { "description": "Request to create device-specific global settings", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1FirewallDeviceGlobalSettingsRequest" }, { "description": "Request to create device-specific global settings", "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } ] }, "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceGlobalSettings" }, { "description": "Device-specific global settings. One per device, inherits from tenant's GlobalSettings.", "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/firewall_device_global_settings/{uuid}": { "get": { "tags": [ "DeviceGlobalSettings" ], "summary": "GetDeviceGlobalSettings", "description": "Retrieve device-specific global settings by UUID.", "operationId": "GetDeviceGlobalSettings", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the device global settings resource", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceGlobalSettings" }, { "description": "Device-specific global settings. One per device, inherits from tenant's GlobalSettings.", "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "DeviceGlobalSettings" ], "summary": "DeleteDeviceGlobalSettings", "description": "Delete device-specific global settings by UUID.", "operationId": "DeleteDeviceGlobalSettings", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the device global settings resource", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "DeviceGlobalSettings" ], "summary": "UpdateDeviceGlobalSettings", "description": "Update device-specific global settings. Parent is automatically maintained.", "operationId": "UpdateDeviceGlobalSettings", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID of the device global settings resource", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateDeviceGlobalSettingsRequest" }, { "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } ] }, "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeviceGlobalSettings" }, { "description": "Device-specific global settings. One per device, inherits from tenant's GlobalSettings.", "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } ] }, "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/firewall_global_profiles": { "get": { "tags": [ "GlobalProfile" ], "summary": "GetGlobalProfile", "description": "Retrieve GlobalProfile for a tenant", "operationId": "GetGlobalProfile", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GlobalProfile" }, { "description": "Global profile for a tenant", "example": { "name": "string", "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } } ] }, "example": { "name": "string", "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "GlobalProfile" ], "summary": "UpdateGlobalProfile", "description": "Update the global-profile for a tenant. GlobalProfile is a singleton per tenant.", "operationId": "UpdateGlobalProfile", "parameters": [], "requestBody": { "description": "Request to update a global profile. Note: Name cannot be modified as GlobalProfile is a singleton per tenant.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1FirewallGlobalProfilesRequest" }, { "description": "Request to update a global profile. Note: Name cannot be modified as GlobalProfile is a singleton per tenant.", "example": { "description": "string", "aamw_profile": { "uuid": "string" }, "dynamic_application": { "uuid": "string" }, "flow_based_antivirus_profile": { "uuid": "string" }, "icap_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" }, "secintel_profile_group": { "uuid": "string" }, "ssl_proxy_profile": { "uuid": "string" }, "swp_profile": { "uuid": "string" }, "utm_profile": { "uuid": "string" } } } ] }, "example": { "description": "string", "aamw_profile": { "uuid": "string" }, "dynamic_application": { "uuid": "string" }, "flow_based_antivirus_profile": { "uuid": "string" }, "icap_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" }, "secintel_profile_group": { "uuid": "string" }, "ssl_proxy_profile": { "uuid": "string" }, "swp_profile": { "uuid": "string" }, "utm_profile": { "uuid": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GlobalProfile" }, { "description": "Global profile for a tenant", "example": { "name": "string", "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } } ] }, "example": { "name": "string", "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/firewall_global_settings": { "get": { "tags": [ "GlobalSettings" ], "summary": "GetGlobalSettings", "description": "Retrieve GlobalSettings for a tenant (JSEC). GlobalSettings is a singleton per tenant.", "operationId": "GetGlobalSettings", "parameters": [], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GlobalSettings" }, { "description": "Global settings for a tenant (singleton object)", "example": { "name": "string", "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } ] }, "example": { "name": "string", "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "GlobalSettings" ], "summary": "UpdateGlobalSettings", "description": "Update the global-settings for a tenant", "operationId": "UpdateGlobalSettings", "parameters": [], "requestBody": { "description": "Request to update global settings. Note: Name cannot be modified as GlobalSettings is a singleton per tenant.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1FirewallGlobalSettingsRequest" }, { "description": "Request to update global settings. Note: Name cannot be modified as GlobalSettings is a singleton per tenant.", "example": { "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } ] }, "example": { "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GlobalSettings" }, { "description": "Global settings for a tenant (singleton object)", "example": { "name": "string", "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } ] }, "example": { "name": "string", "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_anomaly_tests": { "get": { "tags": [ "IPSSignature" ], "summary": "ListAnomalyTests", "description": "Retrieve the list of IPS anomaly tests. Optionally filter by service name (e.g., TELNET, HTTP). Returns the matching anomaly test names and total count.", "operationId": "ListAnomalyTests", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "service", "in": "query", "description": "service selected, based on this the anomaly tests are returned", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListAnomalyTestsResponse" }, { "example": { "items": [ "string" ], "count": 1 } } ] }, "example": { "items": [ "string" ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_signature_categories": { "get": { "tags": [ "IPSSignature" ], "summary": "ListSignatureCategories", "description": "Retrieve the list of IPS signature categories. Returns all available category names sorted alphabetically.", "operationId": "ListSignatureCategories", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSignatureCategoriesResponse" }, { "example": { "items": [ "string" ], "count": 1 } } ] }, "example": { "items": [ "string" ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_signatures": { "get": { "tags": [ "IPSSignature" ], "summary": "ListIpsSignature", "description": "List all ips-signatures based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIpsSignature", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIpsSignatureResponse" }, { "description": "Response containing a list of ips signatures" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IPSSignature" ], "summary": "CreateIpsSignature", "description": "Create a new ips-signature with the provided configuration. Validates input before creation.", "operationId": "CreateIpsSignature", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpsSignatureInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsSignature" }, { "description": "ips_signature object" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_signatures/{uuid}": { "get": { "tags": [ "IPSSignature" ], "summary": "GetIpsSignature", "description": "Retrieve a specific ips-signature by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIpsSignature", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips signature", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsSignature" }, { "description": "ips_signature object" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IPSSignature" ], "summary": "DeleteIpsSignature", "description": "Delete a specific ips-signature by ID. Permanently removes the resource.", "operationId": "DeleteIpsSignature", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips signature to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IPSSignature" ], "summary": "UpdateIpsSignature", "description": "Update an existing ips-signature by ID. Supports partial updates with field masks.", "operationId": "UpdateIpsSignature", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips signature to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpsSignatureInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsSignature" }, { "description": "ips_signature object" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles": { "get": { "tags": [ "IpsProfile" ], "summary": "ListIpsProfile", "description": "List all ips-profiles based on given filters. Supports pagination, sorting, and filtering. Only returns SB (Stormbreaker) profiles.", "operationId": "ListIpsProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIpsProfileResponse" }, { "description": "Response containing a list of IPS profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IpsProfile" ], "summary": "CreateIpsProfile", "description": "Create a new ips-profile with the provided configuration. Validates input before creation.", "operationId": "CreateIpsProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsProfileInput" }, { "example": { "name": "string", "description": "string" } } ] }, "example": { "name": "string", "description": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles/{uuid}": { "delete": { "tags": [ "IpsProfile" ], "summary": "DeleteIpsProfile", "description": "Delete a specific ips-profile by ID. Permanently removes the resource.", "operationId": "DeleteIpsProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "get": { "tags": [ "IpsProfile" ], "summary": "GetIpsProfile", "description": "Retrieve a specific ips-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIpsProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IpsProfile" ], "summary": "UpdateIpsProfile", "description": "Update an existing ips-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateIpsProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsProfileInput" }, { "example": { "name": "string", "description": "string" } } ] }, "example": { "name": "string", "description": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsProfile" }, { "example": { "uuid": "string", "name": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles/{profile_uuid}/exempt_rules": { "get": { "tags": [ "IPSExemptRule" ], "summary": "ListIPSExemptRule", "description": "List all IPS exempt rules based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIPSExemptRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Zero-based offset for pagination (default: 0)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of items to return per page (default: 50)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by.\nExample: name(ascending)\n\nField name and direction for sorting, e.g., 'name(ascending)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results. \nExample: filters = ((name contains sometext) and (uuid eq dummy-id))\n\nFilter expression to narrow results, e.g., '(name contains foo)'", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIPSExemptRuleResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IPSExemptRule" ], "summary": "CreateIPSExemptRule", "description": "Create a new IPS exempt rule with the provided configuration. Validates input before creation.", "operationId": "CreateIPSExemptRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSExemptRuleInput" }, { "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } ] }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSExemptRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles/{profile_uuid}/exempt_rules/{rule_uuid}": { "get": { "tags": [ "IPSExemptRule" ], "summary": "GetIPSExemptRule", "description": "Retrieve a specific IPS exempt rule by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIPSExemptRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS exempt rule to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSExemptRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IPSExemptRule" ], "summary": "DeleteIPSExemptRule", "description": "Delete a specific IPS exempt rule by ID. Permanently removes the resource.", "operationId": "DeleteIPSExemptRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS exempt rule to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IPSExemptRule" ], "summary": "UpdateIPSExemptRule", "description": "Update an existing IPS exempt rule by ID. Supports partial updates with field masks.", "operationId": "UpdateIPSExemptRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS exempt rule to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSExemptRuleInput" }, { "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } ] }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSExemptRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles/{profile_uuid}/ips_rules": { "get": { "tags": [ "IPSRule" ], "summary": "ListIPSRule", "description": "List all IPS rules based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIPSRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Zero-based offset for pagination (default: 0)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "Maximum number of items to return per page (default: 50)", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by.\nExample: name(ascending)\n\nField name and direction for sorting, e.g., 'name(ascending)'", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results. \nExample: filters = ((name contains sometext) and (uuid eq dummy-id))\n\nFilter expression to narrow results, e.g., '(name contains foo)'", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIPSRuleResponse" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IPSRule" ], "summary": "CreateIPSRule", "description": "Create a new IPS rule with the provided configuration. Validates input before creation.", "operationId": "CreateIPSRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSRuleInput" }, { "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } ] }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_profiles/{profile_uuid}/ips_rules/{rule_uuid}": { "get": { "tags": [ "IPSRule" ], "summary": "GetIPSRule", "description": "Retrieve a specific IPS rule by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIPSRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS rule to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IPSRule" ], "summary": "DeleteIPSRule", "description": "Delete a specific IPS rule by ID. Permanently removes the resource.", "operationId": "DeleteIPSRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS rule to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IPSRule" ], "summary": "UpdateIPSRule", "description": "Update an existing IPS rule by ID. Supports partial updates with field masks.", "operationId": "UpdateIPSRule", "parameters": [ { "name": "profile_uuid", "in": "path", "description": "UUID of the parent IPS profile", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "UUID of the IPS rule to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSRuleInput" }, { "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } ] }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IPSRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/rule_options": { "get": { "tags": [ "RuleOption" ], "summary": "ListRuleOption", "description": "List all policy-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListRuleOption", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListRuleOptionResponse" }, { "description": "Response containing a list of rule options" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "RuleOption" ], "summary": "CreateRuleOption", "description": "Create a new policy-profile with the provided configuration. Validates input before creation.", "operationId": "CreateRuleOption", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RuleOption" }, { "example": { "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } ] }, "example": { "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RuleOption" }, { "description": "machine identity object details", "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/rule_options/{uuid}": { "get": { "tags": [ "RuleOption" ], "summary": "GetRuleOption", "description": "Retrieve a specific policy-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetRuleOption", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the rule option", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RuleOption" }, { "description": "machine identity object details", "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "RuleOption" ], "summary": "DeleteRuleOption", "description": "Delete a specific policy-profile by ID. Permanently removes the resource.", "operationId": "DeleteRuleOption", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the rule option to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "RuleOption" ], "summary": "UpdateRuleOption", "description": "Update an existing policy-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateRuleOption", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the rule option to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RuleOption" }, { "example": { "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } ] }, "example": { "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RuleOption" }, { "description": "machine identity object details", "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/secintel_profiles": { "get": { "tags": [ "SecintelProfile" ], "summary": "ListSecIntelProfile", "description": "List all secintel-profiles based on given filters. Supports pagination, sorting, and filtering. Only returns SB (Stormbreaker) profiles.", "operationId": "ListSecIntelProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSecIntelProfileResponse" }, { "description": "Response containing a list of SecIntel profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "SecintelProfile" ], "summary": "CreateSecintelProfile", "description": "Create a new secintel-profile with the provided configuration. Validates input before creation.", "operationId": "CreateSecintelProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileInput" }, { "example": { "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } ] }, "example": { "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfile" }, { "description": "secintel-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/secintel_profiles/{uuid}": { "get": { "tags": [ "SecintelProfile" ], "summary": "GetSecintelProfile", "description": "Retrieve a specific secintel-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetSecintelProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfile" }, { "description": "secintel-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "SecintelProfile" ], "summary": "DeleteSecintelProfile", "description": "Delete a specific secintel-profile by ID. Permanently removes the resource.", "operationId": "DeleteSecintelProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "SecintelProfile" ], "summary": "UpdateSecintelProfile", "description": "Update an existing secintel-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateSecintelProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileInput" }, { "example": { "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } ] }, "example": { "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfile" }, { "description": "secintel-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ssl_proxy_profiles": { "get": { "tags": [ "SSLProxyProfile" ], "summary": "ListSSLProxyProfile", "description": "List all ssl-proxy-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListSSLProxyProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSSLProxyProfileResponse" }, { "description": "Response containing a list of sslproxy profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "SSLProxyProfile" ], "summary": "CreateSSLProxyProfile", "description": "Create a new ssl-proxy-profile with the provided configuration. Validates input before creation.", "operationId": "CreateSSLProxyProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLProxyProfileInput" }, { "example": { "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLProxyProfile" }, { "description": "SSL Forward proxy profile object", "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ssl_proxy_profiles/{uuid}": { "get": { "tags": [ "SSLProxyProfile" ], "summary": "GetSSLProxyProfile", "description": "Retrieve a specific ssl-proxy-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetSSLProxyProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslproxy profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLProxyProfile" }, { "description": "SSL Forward proxy profile object", "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "SSLProxyProfile" ], "summary": "DeleteSSLProxyProfile", "description": "Delete a specific ssl-proxy-profile by ID. Permanently removes the resource.", "operationId": "DeleteSSLProxyProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslproxy profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "SSLProxyProfile" ], "summary": "UpdateSSLProxyProfile", "description": "Update an existing ssl-proxy-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateSSLProxyProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslproxy profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLProxyProfileInput" }, { "example": { "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLProxyProfile" }, { "description": "SSL Forward proxy profile object", "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/web_filtering_profiles": { "get": { "tags": [ "WebFilteringProfile" ], "summary": "ListWebFilteringProfile", "description": "List all web-filtering-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListWebFilteringProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListWebFilteringProfileResponse" }, { "description": "Response containing a list of web filtering profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "WebFilteringProfile" ], "summary": "CreateWebFilteringProfile", "description": "Create a new web-filtering-profile with the provided configuration. Validates input before creation.", "operationId": "CreateWebFilteringProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebFilteringProfileInput" }, { "example": { "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } ] }, "example": { "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebFilteringProfile" }, { "description": "web-filtering-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/web_filtering_profiles/{uuid}": { "get": { "tags": [ "WebFilteringProfile" ], "summary": "GetWebFilteringProfile", "description": "Retrieve a specific web-filtering-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetWebFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the web filtering profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebFilteringProfile" }, { "description": "web-filtering-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "WebFilteringProfile" ], "summary": "DeleteWebFilteringProfile", "description": "Delete a specific web-filtering-profile by ID. Permanently removes the resource.", "operationId": "DeleteWebFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the web filtering profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "WebFilteringProfile" ], "summary": "UpdateWebFilteringProfile", "description": "Update an existing web-filtering-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateWebFilteringProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the web filtering profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebFilteringProfileInput" }, { "example": { "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } ] }, "example": { "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/WebFilteringProfile" }, { "description": "web-filtering-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/addresses": { "get": { "tags": [ "Address" ], "summary": "ListAddress", "description": "List all addresss based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListAddress", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListAddressResponse" }, { "description": "Response containing a list of addresss", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Address" ], "summary": "CreateAddress", "description": "Create a new address with the provided configuration. Validates input before creation.", "operationId": "CreateAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddressInput" }, { "example": { "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Address" }, { "description": "address object", "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/addresses/{uuid}": { "get": { "tags": [ "Address" ], "summary": "GetAddress", "description": "Retrieve a specific address by ID. Fetches detailed information using its unique identifier.", "operationId": "GetAddress", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the address", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Address" }, { "description": "address object", "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Address" ], "summary": "DeleteAddress", "description": "Delete a specific address by ID. Permanently removes the resource.", "operationId": "DeleteAddress", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the address to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Address" ], "summary": "UpdateAddress", "description": "Update an existing address by ID. Supports partial updates with field masks.", "operationId": "UpdateAddress", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the address to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddressInput" }, { "example": { "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Address" }, { "description": "address object", "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/anti_spam_profiles": { "get": { "tags": [ "AntiSpamProfile" ], "summary": "ListAntiSpamProfile", "description": "List all anti-spam-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListAntiSpamProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListAntiSpamProfileResponse" }, { "description": "Response containing a list of anti spam profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "AntiSpamProfile" ], "summary": "CreateAntiSpamProfile", "description": "Create a new anti-spam-profile with the provided configuration. Validates input before creation.", "operationId": "CreateAntiSpamProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiSpamProfileInput" }, { "example": { "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } ] }, "example": { "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiSpamProfile" }, { "description": "anti-spam-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/anti_spam_profiles/{uuid}": { "get": { "tags": [ "AntiSpamProfile" ], "summary": "GetAntiSpamProfile", "description": "Retrieve a specific anti-spam-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetAntiSpamProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti spam profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiSpamProfile" }, { "description": "anti-spam-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "AntiSpamProfile" ], "summary": "DeleteAntiSpamProfile", "description": "Delete a specific anti-spam-profile by ID. Permanently removes the resource.", "operationId": "DeleteAntiSpamProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti spam profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "AntiSpamProfile" ], "summary": "UpdateAntiSpamProfile", "description": "Update an existing anti-spam-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateAntiSpamProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti spam profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiSpamProfileInput" }, { "example": { "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } ] }, "example": { "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiSpamProfile" }, { "description": "anti-spam-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/anti_virus_profiles": { "get": { "tags": [ "AntiVirusProfile" ], "summary": "ListAntiVirusProfile", "description": "List all anti-virus-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListAntiVirusProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListAntiVirusProfileResponse" }, { "description": "Response containing a list of anti virus profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "AntiVirusProfile" ], "summary": "CreateAntiVirusProfile", "description": "Create a new anti-virus-profile with the provided configuration. Validates input before creation.", "operationId": "CreateAntiVirusProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiVirusProfileInput" }, { "example": { "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } ] }, "example": { "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiVirusProfile" }, { "description": "anti-virus-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/anti_virus_profiles/{uuid}": { "get": { "tags": [ "AntiVirusProfile" ], "summary": "GetAntiVirusProfile", "description": "Retrieve a specific anti-virus-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetAntiVirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti virus profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiVirusProfile" }, { "description": "anti-virus-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "AntiVirusProfile" ], "summary": "DeleteAntiVirusProfile", "description": "Delete a specific anti-virus-profile by ID. Permanently removes the resource.", "operationId": "DeleteAntiVirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti virus profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "AntiVirusProfile" ], "summary": "UpdateAntiVirusProfile", "description": "Update an existing anti-virus-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateAntiVirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the anti virus profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiVirusProfileInput" }, { "example": { "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } ] }, "example": { "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AntiVirusProfile" }, { "description": "anti-virus-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/applications": { "get": { "tags": [ "Application" ], "summary": "ListApplication", "description": "List all applications based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListApplication", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListApplicationResponse" }, { "description": "Response containing a list of applications", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [] }, "signature_based": { "protocol": [] } }, "application": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [] }, "signature_based": { "protocol": [] } }, "application": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Application" ], "summary": "CreateApplication", "description": "Create a new application with the provided configuration. Validates input before creation.", "operationId": "CreateApplication", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationInput" }, { "example": { "name": "string", "description": "string", "app_sig_type": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "app_sig_type": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Application" }, { "description": "application object", "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/applications/{uuid}": { "get": { "tags": [ "Application" ], "summary": "GetApplication", "description": "Retrieve a specific application by ID. Fetches detailed information using its unique identifier.", "operationId": "GetApplication", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the application", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Application" }, { "description": "application object", "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Application" ], "summary": "DeleteApplication", "description": "Delete a specific application by ID. Permanently removes the resource.", "operationId": "DeleteApplication", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the application to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Application" ], "summary": "UpdateApplication", "description": "Update an existing application by ID. Supports partial updates with field masks.", "operationId": "UpdateApplication", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the application to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApplicationInput" }, { "example": { "name": "string", "description": "string", "app_sig_type": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "app_sig_type": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Application" }, { "description": "application object", "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] }, "signature_based": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [] } ] } }, "application": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/flow_based_antivirus_profiles": { "get": { "tags": [ "FlowBasedAntivirusProfile" ], "summary": "ListFlowBasedAntivirusProfile", "description": "List all flow-based-antivirus-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListFlowBasedAntivirusProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListFlowBasedAntivirusProfileResponse" }, { "description": "Response containing a list of flow based antivirus profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "FlowBasedAntivirusProfile" ], "summary": "CreateFlowBasedAntivirusProfile", "description": "Create a new flow-based-antivirus-profile with the provided configuration. Validates input before creation.", "operationId": "CreateFlowBasedAntivirusProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FlowBasedAntivirusProfileInput" }, { "example": { "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } ] }, "example": { "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FlowBasedAntivirusProfile" }, { "description": "flow based anti-virus profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/flow_based_antivirus_profiles/{uuid}": { "get": { "tags": [ "FlowBasedAntivirusProfile" ], "summary": "GetFlowBasedAntivirusProfile", "description": "Retrieve a specific flow-based-antivirus-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetFlowBasedAntivirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the flow based antivirus profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FlowBasedAntivirusProfile" }, { "description": "flow based anti-virus profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "FlowBasedAntivirusProfile" ], "summary": "DeleteFlowBasedAntivirusProfile", "description": "Delete a specific flow-based-antivirus-profile by ID. Permanently removes the resource.", "operationId": "DeleteFlowBasedAntivirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the flow based antivirus profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "FlowBasedAntivirusProfile" ], "summary": "UpdateFlowBasedAntivirusProfile", "description": "Update an existing flow-based-antivirus-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateFlowBasedAntivirusProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the flow based antivirus profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FlowBasedAntivirusProfileInput" }, { "example": { "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } ] }, "example": { "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FlowBasedAntivirusProfile" }, { "description": "flow based anti-virus profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/icap_profiles": { "get": { "tags": [ "IcapProfile" ], "summary": "ListIcapProfile", "description": "List all icap-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIcapProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIcapProfileResponse" }, { "description": "Response containing a list of icap profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IcapProfile" ], "summary": "CreateIcapProfile", "description": "Create a new icap-profile with the provided configuration. Validates input before creation.", "operationId": "CreateIcapProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapProfileInput" }, { "example": { "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapProfile" }, { "description": "icap-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/icap_profiles/{uuid}": { "get": { "tags": [ "IcapProfile" ], "summary": "GetIcapProfile", "description": "Retrieve a specific icap-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIcapProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapProfile" }, { "description": "icap-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IcapProfile" ], "summary": "DeleteIcapProfile", "description": "Delete a specific icap-profile by ID. Permanently removes the resource.", "operationId": "DeleteIcapProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IcapProfile" ], "summary": "UpdateIcapProfile", "description": "Update an existing icap-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateIcapProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapProfileInput" }, { "example": { "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapProfile" }, { "description": "icap-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/icap_servers": { "get": { "tags": [ "IcapServer" ], "summary": "ListIcapServer", "description": "List all icap-servers based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIcapServer", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIcapServerResponse" }, { "description": "Response containing a list of icap servers", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IcapServer" ], "summary": "CreateIcapServer", "description": "Create a new icap-server with the provided configuration. Validates input before creation.", "operationId": "CreateIcapServer", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapServerInput" }, { "example": { "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapServer" }, { "description": "icap server object", "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/icap_servers/{uuid}": { "get": { "tags": [ "IcapServer" ], "summary": "GetIcapServer", "description": "Retrieve a specific icap-server by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIcapServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap server", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapServer" }, { "description": "icap server object", "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IcapServer" ], "summary": "DeleteIcapServer", "description": "Delete a specific icap-server by ID. Permanently removes the resource.", "operationId": "DeleteIcapServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap server to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IcapServer" ], "summary": "UpdateIcapServer", "description": "Update an existing icap-server by ID. Supports partial updates with field masks.", "operationId": "UpdateIcapServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the icap server to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapServerInput" }, { "example": { "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IcapServer" }, { "description": "icap server object", "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/identity_objects": { "get": { "tags": [ "IdentityObject" ], "summary": "ListIdentityObject", "description": "List all identity-objects based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIdentityObject", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIdentityObjectResponse" }, { "description": "Response containing a list of identity objects", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "IdentityObject" ], "summary": "CreateIdentityObject", "description": "Create a new identity-object with the provided configuration. Validates input before creation.", "operationId": "CreateIdentityObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityObjectInput" }, { "example": { "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityObject" }, { "description": "identity object", "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/identity_objects/{uuid}": { "get": { "tags": [ "IdentityObject" ], "summary": "GetIdentityObject", "description": "Retrieve a specific identity-object by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIdentityObject", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the identity object", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityObject" }, { "description": "identity object", "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "IdentityObject" ], "summary": "DeleteIdentityObject", "description": "Delete a specific identity-object by ID. Permanently removes the resource.", "operationId": "DeleteIdentityObject", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the identity object to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "IdentityObject" ], "summary": "UpdateIdentityObject", "description": "Update an existing identity-object by ID. Supports partial updates with field masks.", "operationId": "UpdateIdentityObject", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the identity object to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityObjectInput" }, { "example": { "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IdentityObject" }, { "description": "identity object", "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_contexts": { "get": { "tags": [ "IpsContext" ], "summary": "ListIpsContext", "description": "List all ips-contexts based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIpsContext", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIpsContextResponse" }, { "description": "Response containing a list of ips contexts", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_contexts/{uuid}": { "get": { "tags": [ "IpsContext" ], "summary": "GetIpsContext", "description": "Retrieve a specific ips-context by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIpsContext", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips context", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsContext" }, { "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_services": { "get": { "tags": [ "IpsService" ], "summary": "ListIpsService", "description": "List all ips-services based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIpsService", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIpsServiceResponse" }, { "description": "Response containing a list of ips services", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_services/{uuid}": { "get": { "tags": [ "IpsService" ], "summary": "GetIpsService", "description": "Retrieve a specific ips-service by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIpsService", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips service", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsService" }, { "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_vulnerabilities": { "get": { "tags": [ "IpsVulnerability" ], "summary": "ListIpsVulnerability", "description": "List all ips-vulnerabilitys based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListIpsVulnerability", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListIpsVulnerabilityResponse" }, { "description": "Response containing a list of ips vulnerabilitys", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ips_vulnerabilities/{uuid}": { "get": { "tags": [ "IpsVulnerability" ], "summary": "GetIpsVulnerability", "description": "Retrieve a specific ips-vulnerability by ID. Fetches detailed information using its unique identifier.", "operationId": "GetIpsVulnerability", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the ips vulnerability", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IpsVulnerability" }, { "example": { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/proxy_servers": { "get": { "tags": [ "ProxyServer" ], "summary": "ListProxyServer", "description": "List all proxy-servers based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListProxyServer", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListProxyServerResponse" }, { "description": "Response containing a list of proxy servers", "example": { "items": [ { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "ProxyServer" ], "summary": "CreateProxyServer", "description": "Create a new proxy-server with the provided configuration. Validates input before creation.", "operationId": "CreateProxyServer", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServerInput" }, { "example": { "name": "string", "ip_address": "string", "port": 1 } } ] }, "example": { "name": "string", "ip_address": "string", "port": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServer" }, { "description": "proxy server object", "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } ] }, "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/proxy_servers/{uuid}": { "get": { "tags": [ "ProxyServer" ], "summary": "GetProxyServer", "description": "Retrieve a specific proxy-server by ID. Fetches detailed information using its unique identifier.", "operationId": "GetProxyServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the proxy server", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServer" }, { "description": "proxy server object", "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } ] }, "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "ProxyServer" ], "summary": "DeleteProxyServer", "description": "Delete a specific proxy-server by ID. Permanently removes the resource.", "operationId": "DeleteProxyServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the proxy server to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "ProxyServer" ], "summary": "UpdateProxyServer", "description": "Update an existing proxy-server by ID. Supports partial updates with field masks.", "operationId": "UpdateProxyServer", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the proxy server to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServerInput" }, { "example": { "name": "string", "ip_address": "string", "port": 1 } } ] }, "example": { "name": "string", "ip_address": "string", "port": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProxyServer" }, { "description": "proxy server object", "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } ] }, "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/redirect_profiles": { "get": { "tags": [ "RedirectProfile" ], "summary": "ListRedirectProfile", "description": "List all redirect-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListRedirectProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListRedirectProfileResponse" }, { "description": "Response containing a list of redirect profiles", "example": { "items": [ { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "RedirectProfile" ], "summary": "CreateRedirectProfile", "description": "Create a new redirect-profile with the provided configuration. Validates input before creation.", "operationId": "CreateRedirectProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedirectProfileInput" }, { "example": { "name": "string", "block_message": "string", "block_message_type": "string" } } ] }, "example": { "name": "string", "block_message": "string", "block_message_type": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedirectProfile" }, { "description": "Redirect profile object", "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } ] }, "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/redirect_profiles/{uuid}": { "get": { "tags": [ "RedirectProfile" ], "summary": "GetRedirectProfile", "description": "Retrieve a specific redirect-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetRedirectProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the redirect profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedirectProfile" }, { "description": "Redirect profile object", "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } ] }, "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "RedirectProfile" ], "summary": "DeleteRedirectProfile", "description": "Delete a specific redirect-profile by ID. Permanently removes the resource.", "operationId": "DeleteRedirectProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the redirect profile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "RedirectProfile" ], "summary": "UpdateRedirectProfile", "description": "Update an existing redirect-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateRedirectProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the redirect profile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedirectProfileInput" }, { "example": { "name": "string", "block_message": "string", "block_message_type": "string" } } ] }, "example": { "name": "string", "block_message": "string", "block_message_type": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RedirectProfile" }, { "description": "Redirect profile object", "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } ] }, "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/schedulers": { "get": { "tags": [ "Scheduler" ], "summary": "ListScheduler", "description": "List all schedulers based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListScheduler", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSchedulerResponse" }, { "description": "Response containing a list of schedulers", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Scheduler" ], "summary": "CreateScheduler", "description": "Create a new scheduler with the provided configuration. Validates input before creation.", "operationId": "CreateScheduler", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SchedulerInput" }, { "example": { "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } ] }, "example": { "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Scheduler" }, { "description": "Scheduler object", "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/schedulers/{uuid}": { "get": { "tags": [ "Scheduler" ], "summary": "GetScheduler", "description": "Retrieve a specific scheduler by ID. Fetches detailed information using its unique identifier.", "operationId": "GetScheduler", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the scheduler", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Scheduler" }, { "description": "Scheduler object", "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Scheduler" ], "summary": "DeleteScheduler", "description": "Delete a specific scheduler by ID. Permanently removes the resource.", "operationId": "DeleteScheduler", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the scheduler to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Scheduler" ], "summary": "UpdateScheduler", "description": "Update an existing scheduler by ID. Supports partial updates with field masks.", "operationId": "UpdateScheduler", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the scheduler to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SchedulerInput" }, { "example": { "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } ] }, "example": { "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Scheduler" }, { "description": "Scheduler object", "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/secintel_profiles_groups": { "get": { "tags": [ "SecintelProfileGroup" ], "summary": "ListSecintelProfileGroup", "description": "List all secintel-profile-groups based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListSecintelProfileGroup", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSecintelProfileGroupResponse" }, { "description": "Response containing a list of secintel profile groups", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "SecintelProfileGroup" ], "summary": "CreateSecintelProfileGroup", "description": "Create a new secintel-profile-group with the provided configuration. Validates input before creation.", "operationId": "CreateSecintelProfileGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileGroupInput" }, { "example": { "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileGroup" }, { "description": "secintel-profile-groups object", "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/secintel_profiles_groups/{uuid}": { "get": { "tags": [ "SecintelProfileGroup" ], "summary": "GetSecintelProfileGroup", "description": "Retrieve a specific secintel-profile-group by ID. Fetches detailed information using its unique identifier.", "operationId": "GetSecintelProfileGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile group", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileGroup" }, { "description": "secintel-profile-groups object", "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "SecintelProfileGroup" ], "summary": "DeleteSecintelProfileGroup", "description": "Delete a specific secintel-profile-group by ID. Permanently removes the resource.", "operationId": "DeleteSecintelProfileGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile group to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "SecintelProfileGroup" ], "summary": "UpdateSecintelProfileGroup", "description": "Update an existing secintel-profile-group by ID. Supports partial updates with field masks.", "operationId": "UpdateSecintelProfileGroup", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the secintel profile group to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileGroupInput" }, { "example": { "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SecintelProfileGroup" }, { "description": "secintel-profile-groups object", "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/services": { "get": { "tags": [ "Services" ], "summary": "ListServices", "description": "List all servicess based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListServices", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListServicesResponse" }, { "description": "Response containing a list of servicess", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Services" ], "summary": "CreateServices", "description": "Create a new services with the provided configuration. Validates input before creation.", "operationId": "CreateServices", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ServicesInput" }, { "example": { "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Services" }, { "description": "service object", "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/services/{uuid}": { "get": { "tags": [ "Services" ], "summary": "GetServices", "description": "Retrieve a specific services by ID. Fetches detailed information using its unique identifier.", "operationId": "GetServices", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the services", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Services" }, { "description": "service object", "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Services" ], "summary": "DeleteServices", "description": "Delete a specific services by ID. Permanently removes the resource.", "operationId": "DeleteServices", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the services to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Services" ], "summary": "UpdateServices", "description": "Update an existing services by ID. Supports partial updates with field masks.", "operationId": "UpdateServices", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the services to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ServicesInput" }, { "example": { "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Services" }, { "description": "service object", "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ssl_initiations": { "get": { "tags": [ "SSLInitiation" ], "summary": "ListSSLInitiation", "description": "List all ssl-initiations based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListSSLInitiation", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSSLInitiationResponse" }, { "description": "Response containing a list of sslinitiations", "example": { "items": [ { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "SSLInitiation" ], "summary": "CreateSSLInitiation", "description": "Create a new ssl-initiation with the provided configuration. Validates input before creation.", "operationId": "CreateSSLInitiation", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLInitiationInput" }, { "example": { "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } ] }, "example": { "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLInitiation" }, { "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } ] }, "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/ssl_initiations/{uuid}": { "get": { "tags": [ "SSLInitiation" ], "summary": "GetSSLInitiation", "description": "Retrieve a specific ssl-initiation by ID. Fetches detailed information using its unique identifier.", "operationId": "GetSSLInitiation", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslinitiation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLInitiation" }, { "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } ] }, "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "SSLInitiation" ], "summary": "DeleteSSLInitiation", "description": "Delete a specific ssl-initiation by ID. Permanently removes the resource.", "operationId": "DeleteSSLInitiation", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslinitiation to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "SSLInitiation" ], "summary": "UpdateSSLInitiation", "description": "Update an existing ssl-initiation by ID. Supports partial updates with field masks.", "operationId": "UpdateSSLInitiation", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the sslinitiation to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLInitiationInput" }, { "example": { "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } ] }, "example": { "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SSLInitiation" }, { "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } ] }, "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/swp_profiles": { "get": { "tags": [ "SWPProfile" ], "summary": "ListSWPProfile", "description": "List all swp-profiles based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListSWPProfile", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSWPProfileResponse" }, { "description": "Response containing a list of swpprofiles", "example": { "items": [ { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "SWPProfile" ], "summary": "CreateSWPProfile", "description": "Create a new swp-profile with the provided configuration. Validates input before creation.", "operationId": "CreateSWPProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SWPProfileInput" }, { "example": { "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SWPProfile" }, { "description": "swp_profile object", "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/swp_profiles/{uuid}": { "get": { "tags": [ "SWPProfile" ], "summary": "GetSWPProfile", "description": "Retrieve a specific swp-profile by ID. Fetches detailed information using its unique identifier.", "operationId": "GetSWPProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the swpprofile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SWPProfile" }, { "description": "swp_profile object", "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "SWPProfile" ], "summary": "DeleteSWPProfile", "description": "Delete a specific swp-profile by ID. Permanently removes the resource.", "operationId": "DeleteSWPProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the swpprofile to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "SWPProfile" ], "summary": "UpdateSWPProfile", "description": "Update an existing swp-profile by ID. Supports partial updates with field masks.", "operationId": "UpdateSWPProfile", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the swpprofile to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SWPProfileInput" }, { "example": { "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SWPProfile" }, { "description": "swp_profile object", "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/url_category_lists": { "get": { "tags": [ "URLCategoryList" ], "summary": "ListURLCategoryList", "description": "List all url-category-lists based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListURLCategoryList", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListURLCategoryListResponse" }, { "description": "Response containing a list of urlcategory lists", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "URLCategoryList" ], "summary": "CreateURLCategoryList", "description": "Create a new url-category-list with the provided configuration. Validates input before creation.", "operationId": "CreateURLCategoryList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLCategoryListInput" }, { "example": { "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLCategoryList" }, { "description": "url-categories object", "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/url_category_lists/{uuid}": { "get": { "tags": [ "URLCategoryList" ], "summary": "GetURLCategoryList", "description": "Retrieve a specific url-category-list by ID. Fetches detailed information using its unique identifier.", "operationId": "GetURLCategoryList", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlcategory list", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLCategoryList" }, { "description": "url-categories object", "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "URLCategoryList" ], "summary": "DeleteURLCategoryList", "description": "Delete a specific url-category-list by ID. Permanently removes the resource.", "operationId": "DeleteURLCategoryList", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlcategory list to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "URLCategoryList" ], "summary": "UpdateURLCategoryList", "description": "Update an existing url-category-list by ID. Supports partial updates with field masks.", "operationId": "UpdateURLCategoryList", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlcategory list to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLCategoryListInput" }, { "example": { "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLCategoryList" }, { "description": "url-categories object", "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/url_patterns": { "get": { "tags": [ "URLPatterns" ], "summary": "ListURLPatterns", "description": "List all url-patternss based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListURLPatterns", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListURLPatternsResponse" }, { "description": "Response containing a list of urlpatternss", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "URLPatterns" ], "summary": "CreateURLPatterns", "description": "Create a new url-patterns with the provided configuration. Validates input before creation.", "operationId": "CreateURLPatterns", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLPatternsInput" }, { "example": { "name": "string", "description": "string", "address_patterns": [ "string" ] } } ] }, "example": { "name": "string", "description": "string", "address_patterns": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLPatterns" }, { "description": "url-patterns object", "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/url_patterns/{uuid}": { "get": { "tags": [ "URLPatterns" ], "summary": "GetURLPatterns", "description": "Retrieve a specific url-patterns by ID. Fetches detailed information using its unique identifier.", "operationId": "GetURLPatterns", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlpatterns", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLPatterns" }, { "description": "url-patterns object", "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "URLPatterns" ], "summary": "DeleteURLPatterns", "description": "Delete a specific url-patterns by ID. Permanently removes the resource.", "operationId": "DeleteURLPatterns", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlpatterns to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "URLPatterns" ], "summary": "UpdateURLPatterns", "description": "Update an existing url-patterns by ID. Supports partial updates with field masks.", "operationId": "UpdateURLPatterns", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the urlpatterns to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLPatternsInput" }, { "example": { "name": "string", "description": "string", "address_patterns": [ "string" ] } } ] }, "example": { "name": "string", "description": "string", "address_patterns": [ "string" ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/URLPatterns" }, { "description": "url-patterns object", "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/variable_zones": { "get": { "tags": [ "VariableZone" ], "summary": "ListVariableZone", "description": "List all variable-zones based on given filters. Supports pagination, sorting, and filtering.", "operationId": "ListVariableZone", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListVariableZoneResponse" }, { "description": "Response containing a list of variable zones", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } ], "count": "string" } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "VariableZone" ], "summary": "CreateVariableZone", "description": "Create a new variable-zone with the provided configuration. Validates input before creation.", "operationId": "CreateVariableZone", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VariableZoneInput" }, { "example": { "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VariableZone" }, { "description": "zone set object", "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/variable_zones/{uuid}": { "get": { "tags": [ "VariableZone" ], "summary": "GetVariableZone", "description": "Retrieve a specific variable-zone by ID. Fetches detailed information using its unique identifier.", "operationId": "GetVariableZone", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the variable zone", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VariableZone" }, { "description": "zone set object", "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "VariableZone" ], "summary": "DeleteVariableZone", "description": "Delete a specific variable-zone by ID. Permanently removes the resource.", "operationId": "DeleteVariableZone", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the variable zone to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "VariableZone" ], "summary": "UpdateVariableZone", "description": "Update an existing variable-zone by ID. Supports partial updates with field masks.", "operationId": "UpdateVariableZone", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the variable zone to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VariableZoneInput" }, { "example": { "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } ] }, "example": { "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VariableZone" }, { "description": "zone set object", "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/cleanup": { "post": { "tags": [ "Policy Cleanup" ], "summary": "CleanupMultiplePolicies", "description": "Batch cleanup multiple policies (firewall or nat) completely from devices and system. Each policy is undeployed from all devices where currently deployed and has all its assignments deleted from the system. Policy is also deleted from the system. This is a complete cleanup operation for each policy in the batch. Currently one request can only contain one policy type (all firewall or all nat), but this may be relaxed in the future. This is an asynchronous operation that returns a cleanup ID for tracking the entire batch operation.", "operationId": "CleanupMultiplePolicies", "parameters": [], "requestBody": { "description": "Request to cleanup multiple policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1PoliciesCleanupRequest" }, { "description": "Request to cleanup multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ], "cleanup_mode": "STRICT" } } ] }, "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ], "cleanup_mode": "STRICT" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CleanupPolicyResponse" }, { "description": "Response for cleanup operations", "example": { "cleanup_id": "string" } } ] }, "example": { "cleanup_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/cleanup/{cleanup_id}": { "get": { "tags": [ "Policy Cleanup" ], "summary": "GetPolicyCleanupStatus", "description": "Retrieves cleanup operation status including per-device undeploy status and assignment removal status.", "operationId": "GetPolicyCleanupStatus", "parameters": [ { "name": "cleanup_id", "in": "path", "description": "Cleanup ID from the cleanup operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyCleanupStatusResponse" }, { "description": "Response containing cleanup operation status", "example": { "cleanup_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } ] }, "example": { "cleanup_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/cleanup/{cleanup_id}/devices/{device_id}": { "get": { "tags": [ "Policy Cleanup" ], "summary": "GetPolicyCleanupResultByDevice", "description": "Retrieves cleanup result for specific device.", "operationId": "GetPolicyCleanupResultByDevice", "parameters": [ { "name": "cleanup_id", "in": "path", "description": "Cleanup ID from the cleanup operation", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/format1" }, { "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format" } ] } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyCleanupResultByDeviceResponse" }, { "description": "Response containing cleanup result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } ] }, "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/cleanup": { "post": { "tags": [ "Policy Cleanup" ], "summary": "CleanupSingleFirewallPolicy", "description": "Completely removes a firewall policy from devices and system - undeploys from all devices where currently deployed and deletes all policy-device assignments from the system. Policy is also deleted from the system. This is a complete cleanup operation. This is an asynchronous operation that returns a cleanup ID for tracking the status of the cleanup operation.", "operationId": "CleanupSingleFirewallPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to cleanup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CleanupPolicyInput" }, { "example": { "cleanup_mode": "STRICT" } } ] }, "example": { "cleanup_mode": "STRICT" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CleanupPolicyResponse" }, { "description": "Response for cleanup operations", "example": { "cleanup_id": "string" } } ] }, "example": { "cleanup_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/cleanup": { "post": { "tags": [ "Policy Cleanup" ], "summary": "CleanupSingleNatPolicy", "description": "Completely removes a NAT policy from devices and system - undeploys from all devices where currently deployed and deletes all policy-device mappings from the system. Policy is also deleted from the system. This is a complete cleanup operation. This is an asynchronous operation that returns a cleanup ID for tracking the status of the cleanup operation.", "operationId": "CleanupSingleNatPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to cleanup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CleanupPolicyInput" }, { "example": { "cleanup_mode": "STRICT" } } ] }, "example": { "cleanup_mode": "STRICT" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CleanupPolicyResponse" }, { "description": "Response for cleanup operations", "example": { "cleanup_id": "string" } } ] }, "example": { "cleanup_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/deploy": { "post": { "tags": [ "Policy Deploy" ], "summary": "DeployMultiplePolicies", "description": "Deploy multiple policies (firewall or NAT) in a single batch operation. Each policy will be deployed to all devices currently assigned to it and undeployed from any devices that are no longer assigned.\n\nDevices must be assigned or unassigned using the Assignments API before invoking this operation. Note that to unassign a device from which the policy is already deployed, the force_unassign option in the Assignments API must be used. Subsequent deploy operations for that policy will then undeploy the policy from those devices.\n\nFor each device undeploy is processed first, then deploy. For each device, operations are atomic; across devices, some may succeed while others fail. Currently one request can only contain one policy type (all firewall or all nat), but this may be relaxed in the future.\n\nThis is an asynchronous operation that returns a deploy ID for tracking the status of the deploy operation.", "operationId": "DeployMultiplePolicies", "parameters": [], "requestBody": { "description": "Request to deploy multiple policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1PoliciesDeployRequest" }, { "description": "Request to deploy multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ] } } ] }, "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployPolicyResponse" }, { "description": "Response for deploy operations", "example": { "deploy_id": "string" } } ] }, "example": { "deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/deploy/{deploy_id}": { "get": { "tags": [ "Policy Deploy" ], "summary": "GetPolicyDeployStatus", "description": "Retrieves deploy operation status including which devices were deployed to, which were undeployed from.", "operationId": "GetPolicyDeployStatus", "parameters": [ { "name": "deploy_id", "in": "path", "description": "Deploy ID from the deploy operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyDeployStatusResponse" }, { "description": "Response containing deploy operation status", "example": { "deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } ] }, "example": { "deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/deploy/{deploy_id}/devices/{device_id}": { "get": { "tags": [ "Policy Deploy" ], "summary": "GetPolicyDeployResultByDevice", "description": "Retrieves deploy result for specific device.", "operationId": "GetPolicyDeployResultByDevice", "parameters": [ { "name": "deploy_id", "in": "path", "description": "Deploy ID from the deploy operation", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/format1" }, { "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format" } ] } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyDeployResultByDeviceResponse" }, { "description": "Response containing deploy result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } ] }, "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/deploy": { "post": { "tags": [ "Policy Deploy" ], "summary": "DeploySingleFirewallPolicy", "description": "Deploys a firewall policy to all the devices assigned to it and undeploys from devices no longer assigned.\n\nDevices must be assigned or unassigned using the Assignments API before invoking this operation. Note that to unassign a device from which the policy is already deployed, the force_unassign option in the Assignments API must be used. Subsequent deploy operations for that policy will then undeploy the policy from those devices.\n\nThis is an asynchronous operation that returns a deploy ID for tracking the status of the deploy operation.", "operationId": "DeploySingleFirewallPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to deploy", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployPolicyResponse" }, { "description": "Response for deploy operations", "example": { "deploy_id": "string" } } ] }, "example": { "deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/deploy": { "post": { "tags": [ "Policy Deploy" ], "summary": "DeploySingleNatPolicy", "description": "Deploys a NAT policy to all the devices assigned to it and undeploys from devices no longer assigned.\n\nDevices must be assigned or unassigned using the Assignments API before invoking this operation. Note that to unassign a device from which the policy is already deployed, the force_unassign option in the Assignments API must be used. Subsequent deploy operations for that policy will then undeploy the policy from those devices.\n\nThis is an asynchronous operation that returns a deploy ID for tracking the status of the deploy operation.", "operationId": "DeploySingleNatPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to deploy", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployPolicyResponse" }, { "description": "Response for deploy operations", "example": { "deploy_id": "string" } } ] }, "example": { "deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall": { "get": { "tags": [ "Firewall Policies" ], "summary": "ListFirewallPolicies", "description": "Retrieve a paginated list of firewall policy with optional filtering and sorting.", "operationId": "ListFirewallPolicies", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by name and description sample: sortby=(name(descending)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListFirewallPoliciesResponse" }, { "description": "Response containing a list of firewall policies, including total count matching the query", "example": { "items": [ { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Firewall Policies" ], "summary": "CreateFirewallPolicies", "description": "Create a new firewall policy. After a policy is created, create rule groups and rules within the policy, then assign devices and deploy the policy.", "operationId": "CreateFirewallPolicies", "parameters": [], "requestBody": { "description": "Request to create a new firewall policy", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1PoliciesFirewallRequest" }, { "description": "Request to create a new firewall policy", "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } ] }, "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyOutput" }, { "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } ] }, "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}": { "get": { "tags": [ "Firewall Policies" ], "summary": "GetFirewallPolicies", "description": "Retrieve a single policy by its UUID.", "operationId": "GetFirewallPolicies", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "The unique identifier of the firewall policies to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyOutput" }, { "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } ] }, "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Firewall Policies" ], "summary": "DeleteFirewallPolicies", "description": "Delete the specified firewall policy from the system. Delete is allowed only if the policy is not assigned/deployed to any devices. If the policy is assigned to devices, it must be undeployed/unassigned from all devices before deletion. Alternatively, cleanup API can be used to force delete the policy along with all its assignments and deployments.", "operationId": "DeleteFirewallPolicies", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "The unique identifier of the firewall policy to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Firewall Policies" ], "summary": "UpdateFirewallPolicies", "description": "Update an existing firewall policy. Modifies the firewall policy information including name, description etc.", "operationId": "UpdateFirewallPolicies", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "UUID of the policy to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPoliciesInput" }, { "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } ] }, "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyOutput" }, { "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } ] }, "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/heirarchy": { "get": { "tags": [ "Firewall Policies" ], "summary": "ListFirewallPolicyHeirarchy", "description": "Retrieve a flat list of all rules and rule groups across the entire hierarchy of the specified firewall policy scope. This API traverses all nesting levels and returns every rule and rule group in a single response. Scope can be 'global' or 'zone'. Supports optional pagination and filtering. Response contains only the common attributes.", "operationId": "ListFirewallPolicyHeirarchy", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, return count only without resource details.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyHeirarchyOutput" }, { "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1, "sequence_number": 1, "type": "string", "scope": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1, "sequence_number": 1, "type": "string", "scope": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/move_rules": { "post": { "tags": [ "Firewall Policies" ], "summary": "BulkMoveFirewallPolicyRules", "description": "Move one or more firewall policy rules to a different position within the policy scope. Scope can be 'global' or 'zone'. Supports relative positioning via an optional reference rule UUID.", "operationId": "BulkMoveFirewallPolicyRules", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules to move.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkMoveFirewallPolicyRulesInput" }, { "example": { "rule_uuids": [ "string" ], "target_rule_group_id": "string", "position": 1, "target_scope": "POLICY_SCOPE_UNSPECIFIED" } } ] }, "example": { "rule_uuids": [ "string" ], "target_rule_group_id": "string", "position": 1, "target_scope": "POLICY_SCOPE_UNSPECIFIED" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFirewallPolicyRuleOutput" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rule_groups": { "get": { "tags": [ "Firewall Policies" ], "summary": "ListFirewallPolicyRuleGroups", "description": "Retrieve a paginated list of rule groups within a firewall policy with optional filtering and sorting. Scope can be 'global' or 'zone'.", "operationId": "ListFirewallPolicyRuleGroups", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFirewallPolicyRuleGroupOutput" }, { "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Firewall Policies" ], "summary": "CreateFirewallPolicyRuleGroup", "description": "Create a new rule group within a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "CreateFirewallPolicyRuleGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID where the rule group will be created", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleGroupInput" }, { "example": { "name": "string", "description": "string", "position": 1 } } ] }, "example": { "name": "string", "description": "string", "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleGroupOutput" }, { "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } ] }, "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rule_groups/{group_uuid}": { "get": { "tags": [ "Firewall Policies" ], "summary": "GetFirewallPolicyRuleGroup", "description": "Retrieve one firewall policy rule group within a policy. Scope can be 'global' or 'zone'.", "operationId": "GetFirewallPolicyRuleGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule groups", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleGroupOutput" }, { "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } ] }, "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Firewall Policies" ], "summary": "DeleteFirewallPolicyRuleGroup", "description": "Delete a rule group from a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "DeleteFirewallPolicyRuleGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID to be deleted", "required": true, "schema": { "type": "string" } }, { "name": "ungroup_rules", "in": "query", "description": "Default value is false. If set to true, the rule group will be deleted and the rules inside it will be ungrouped and moved to the policy level", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Firewall Policies" ], "summary": "UpdateFirewallPolicyRuleGroup", "description": "Update an existing rule group within a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "UpdateFirewallPolicyRuleGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule group", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleGroupInput" }, { "example": { "name": "string", "description": "string", "position": 1 } } ] }, "example": { "name": "string", "description": "string", "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleGroupOutput" }, { "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } ] }, "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rule_groups/{group_uuid}/rules": { "get": { "tags": [ "Firewall Policies" ], "summary": "ListFirewallPolicyRulesInGroup", "description": "Retrieve a paginated list of firewall policy rules from a specific rule group of a firewall policy with optional filtering and sorting. Scope can be 'global' or 'zone'.", "operationId": "ListFirewallPolicyRulesInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFirewallPolicyRuleOutput" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Firewall Policies" ], "summary": "CreateFirewallPolicyRuleInGroup", "description": "Create a new security rule within a specific rule group of a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "CreateFirewallPolicyRuleInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID where the rule will be created.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID where the rule will be created.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleInput" }, { "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } ] }, "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rule_groups/{group_uuid}/rules/{rule_uuid}": { "get": { "tags": [ "Firewall Policies" ], "summary": "GetFirewallPolicyRuleInGroup", "description": "Retrieve one rule by its UUID within a specific rule group of a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "GetFirewallPolicyRuleInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID containing the rule", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to retrieve", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Firewall Policies" ], "summary": "DeleteFirewallPolicyRuleInGroup", "description": "Delete a firewall policy rule within a rule group of a policy. Scope can be 'global' or 'zone'.", "operationId": "DeleteFirewallPolicyRuleInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID containing the rules", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Firewall Policies" ], "summary": "UpdateFirewallPolicyRuleInGroup", "description": "Update an existing firewall policy rule within a rule group of a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "UpdateFirewallPolicyRuleInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule to be updated.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Rule group UUID containing the rule to be updated.", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to be updated.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleInput" }, { "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } ] }, "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rule_groups/{group_uuid}/rules/{rule_uuid}/move": { "post": { "tags": [ "Firewall Policies" ], "summary": "MoveFirewallPolicyRulesInGroup", "description": "Move an existing firewall policy rule within a group to a new position. Scope can be 'global' or 'zone'. Position of other rules in the group will be adjusted accordingly.", "operationId": "MoveFirewallPolicyRulesInGroup", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Parent policy", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope of rule groups: 'global' or 'zone'", "required": true, "schema": { "type": "string" } }, { "name": "group_uuid", "in": "path", "description": "Target rule group to which rule is to be moved", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule uuid that need to be moved", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MoveFirewallPolicyRuleInput" }, { "example": { "position": 1 } } ] }, "example": { "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MoveFirewallPolicyRuleResponse" }, { "description": "Response containing the new position after moving a firewall policy rule", "example": { "position": 1 } } ] }, "example": { "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rules": { "get": { "tags": [ "Firewall Policies" ], "summary": "ListFirewallPolicyRules", "description": "Retrieve a flat list of all rules across the entire hierarchy of the specified firewall policy scope. This API traverses all nesting levels and returns every rule in a single response. Scope can be 'global' or 'zone'. Supports optional pagination and filtering. Response contains complete rule details.", "operationId": "ListFirewallPolicyRules", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rules.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, return count only without resource details.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFirewallPolicyRuleOutput" }, { "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Firewall Policies" ], "summary": "CreateFirewallPolicyRule", "description": "Create a rule in a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "CreateFirewallPolicyRule", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID where the rule will be created.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleInput" }, { "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } ] }, "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/{scope}/rules/{rule_uuid}": { "get": { "tags": [ "Firewall Policies" ], "summary": "GetFirewallPolicyRule", "description": "Retrieve a rule by UUID from a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "GetFirewallPolicyRule", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "Firewall Policies" ], "summary": "DeleteFirewallPolicyRule", "description": "Delete a rule from a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "DeleteFirewallPolicyRule", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "Firewall Policies" ], "summary": "UpdateFirewallPolicyRule", "description": "Update a rule in a firewall policy. Scope can be 'global' or 'zone'.", "operationId": "UpdateFirewallPolicyRule", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "Policy UUID containing the rule.", "required": true, "schema": { "type": "string" } }, { "name": "scope", "in": "path", "description": "Scope: 'global' or 'zone'.", "required": true, "schema": { "type": "string" } }, { "name": "rule_uuid", "in": "path", "description": "Rule UUID to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRuleInput" }, { "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } ] }, "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "identities": [ { "uuid": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string" } ], "url_category_lists": [ { "uuid": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string" }, "redirect_profile": { "uuid": "string" }, "policy_profile": { "inherited": true, "uuid": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string" }, "ips_profile": { "inherited": true, "uuid": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string" }, "aamw_profile": { "inherited": true, "uuid": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string" }, "swp_profile": { "inherited": true, "uuid": "string" }, "icap_profile": { "inherited": true, "uuid": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirewallPolicyRule" }, { "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } ] }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/assignments": { "get": { "tags": [ "Policy Assignment" ], "summary": "ListFirewallPolicyAssignments", "description": "Retrieve a paginated list of firewall policy device assignments with optional filtering and sorting.", "operationId": "ListFirewallPolicyAssignments", "parameters": [ { "name": "policy_id", "in": "path", "description": "Policy ID containing the device assignments", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "sortby", "in": "query", "description": "Field to sort the results by. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response (for partial responses).", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter conditions to apply to the results. Supported operators: eq, ne, contains, excludes.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListFirewallPoliciesMappingDevicesResponse" }, { "description": "Response containing a list of firewall policy device assignments", "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } } ] }, "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/assignments/batch": { "post": { "tags": [ "Policy Assignment" ], "summary": "BatchFirewallPolicyAssignments", "description": "Batch assign and unassign devices for a firewall policy in a single call. A device must be assigned to the policy before the policy can be deployed to the device. By default, unassign is not allowed if the policy is currently deployed to the device — the policy must be undeployed first. Use the force_unassign option to override this check; the subsequent deploy call will undeploy the policy from the forcefully unassigned devices.", "operationId": "BatchFirewallPolicyAssignments", "parameters": [ { "name": "policy_id", "in": "path", "description": "Policy ID to update device assignments for", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchFirewallPoliciesMappingDevicesInput" }, { "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } } ] }, "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchFirewallPoliciesMappingDevicesResponse" }, { "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } } ] }, "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/assignments": { "get": { "tags": [ "Policy Assignment" ], "summary": "ListNatPolicyAssignments", "description": "Retrieve a paginated list of NAT policy device assignments with optional filtering and sorting.", "operationId": "ListNatPolicyAssignments", "parameters": [ { "name": "policy_id", "in": "path", "description": "Policy ID containing the device assignments.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "sortby", "in": "query", "description": "Sort specification. Example: '(name(ascending))' or '(name(descending))'. Defaults to '(name(ascending))'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response (for partial responses).", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression applied to the result set. Supported fields: 'name', 'id'. Supported operators: 'eq', 'contains'. String values must be enclosed in single quotes. Examples: \"(name eq 'my-pool')\", \"(name contains 'my-prefix')\", or \"(id eq 'pool-uuid').\"", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNatPoliciesMappingDevicesResponse" }, { "description": "Response containing a list of NAT policy mapping devices", "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } } ] }, "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/assignments/batch": { "post": { "tags": [ "Policy Assignment" ], "summary": "BatchNatPolicyAssignments", "description": "Batch assign and unassign devices for a NAT policy in a single call. A device must be assigned to the policy before the policy can be deployed to the device. By default, unassign is not allowed if the policy is currently deployed to the device — the policy must be undeployed first. Use the force_unassign option to override this check; the subsequent deploy call will undeploy the policy from the forcefully unassigned devices.", "operationId": "BatchNatPolicyAssignments", "parameters": [ { "name": "policy_id", "in": "path", "description": "Policy ID to update device assignments for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchNatPoliciesMappingDevicesInput" }, { "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } } ] }, "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BatchNatPoliciesMappingDevicesResponse" }, { "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } } ] }, "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/preview": { "post": { "tags": [ "Policy Preview" ], "summary": "PreviewSingleFirewallPolicy", "description": "Generates preview of a firewall policy (deploy or undeploy) configuration without actual deployment. Specify deploy_targets to preview deployment, undeploy_targets to preview removal, or both. Shows the configuration that would be pushed to devices without making any changes. This is an asynchronous operation that returns a preview ID for tracking the status of the preview operation.", "operationId": "PreviewSingleFirewallPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to preview", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewPolicyInput" }, { "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } } ] }, "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewPolicyResponse" }, { "description": "Response for preview operations (single or batch)", "example": { "preview_id": "string" } } ] }, "example": { "preview_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/preview": { "post": { "tags": [ "Policy Preview" ], "summary": "PreviewMultiplePolicies", "description": "Generates previews for multiple policies in a batch operation. Each policy can have deploy_targets and undeploy_targets. For each device, undeploy_targets are processed first, then deploy_targets. This is an asynchronous operation that returns a preview ID for tracking the status of the preview operation.", "operationId": "PreviewMultiplePolicies", "parameters": [], "requestBody": { "description": "Request to preview multiple policies in a batch", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1PoliciesPreviewRequest" }, { "description": "Request to preview multiple policies in a batch", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ] } } ] }, "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewPolicyResponse" }, { "description": "Response for preview operations (single or batch)", "example": { "preview_id": "string" } } ] }, "example": { "preview_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/preview/{preview_id}": { "get": { "tags": [ "Policy Preview" ], "summary": "GetPolicyPreviewStatus", "description": "Retrieves the results of a policy preview operation, including per-device configuration previews and status.", "operationId": "GetPolicyPreviewStatus", "parameters": [ { "name": "preview_id", "in": "path", "description": "Preview ID from the preview operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyPreviewStatusResponse" }, { "description": "Response containing preview status", "example": { "preview_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } ] }, "example": { "preview_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/preview/{preview_id}/devices/{device_id}": { "get": { "tags": [ "Policy Preview" ], "summary": "GetPolicyPreviewResultByDevice", "description": "Retrieves the preview result for a specific device, including the configuration diff and preview status.", "operationId": "GetPolicyPreviewResultByDevice", "parameters": [ { "name": "preview_id", "in": "path", "description": "Preview ID from the preview operation", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Output format for config_diff. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/format3" }, { "description": "Output format for config_diff. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format" } ] } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicyPreviewResultByDeviceResponse" }, { "description": "Response containing preview result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "config_diff": "string", "format": "string", "message": "string" } } ] }, "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "config_diff": "string", "format": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/preview": { "post": { "tags": [ "Policy Preview" ], "summary": "PreviewSingleNatPolicy", "description": "Generates preview of a NAT policy (deploy or undeploy) configuration without actual deployment. Specify deploy_targets to preview deployment, undeploy_targets to preview removal, or both. Shows the configuration that would be pushed to devices without making any changes. This is an asynchronous operation that returns a preview ID for tracking the status of the preview operation.", "operationId": "PreviewSingleNatPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy to preview", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewPolicyInput" }, { "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } } ] }, "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PreviewPolicyResponse" }, { "description": "Response for preview operations (single or batch)", "example": { "preview_id": "string" } } ] }, "example": { "preview_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_id}/selective_deploy": { "post": { "tags": [ "Policy Selective Deploy" ], "summary": "SelectiveDeploySingleFirewallPolicy", "description": "Deploy or undeploy a firewall policy to/from specific target entities (devices). A device must be assigned to the policy using the assignments API before deploying the policy to the device. Specify deploy_targets to deploy to specific devices/device groups, undeploy_targets to remove from specific devices/device groups. This is an asynchronous operation that returns a selective deploy ID for tracking the status of the deploy operation.", "operationId": "SelectiveDeploySingleFirewallPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectiveDeployPolicyInput" }, { "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "unassign_on_undeploy": true } } ] }, "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "unassign_on_undeploy": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectiveDeployPolicyResponse" }, { "description": "Response for selective deploy operations", "example": { "selective_deploy_id": "string" } } ] }, "example": { "selective_deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/selective_deploy": { "post": { "tags": [ "Policy Selective Deploy" ], "summary": "SelectiveDeployMultiplePolicies", "description": "Deploy or undeploy multiple policies (firewall or nat) to/from specific target entities (devices). Devices must be assigned to the policy using the assignments API before deploying. Each policy can have deploy_targets and undeploy_targets. For each device, undeploy_targets are processed first, then deploy_targets. For each device, operations are atomic; across devices, some may succeed while others fail. As of now, one request can only contain one policy type (all firewall or all nat), but this may be relaxed in the future. This is an asynchronous operation that returns a selective deploy ID for tracking the entire batch operation.", "operationId": "SelectiveDeployMultiplePolicies", "parameters": [], "requestBody": { "description": "Request to selective deploy operations across multiple policies", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1PoliciesSelectiveDeployRequest" }, { "description": "Request to selective deploy operations across multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ], "unassign_on_undeploy": true } } ] }, "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ], "unassign_on_undeploy": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectiveDeployPolicyResponse" }, { "description": "Response for selective deploy operations", "example": { "selective_deploy_id": "string" } } ] }, "example": { "selective_deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/selective_deploy/{selective_deploy_id}": { "get": { "tags": [ "Policy Selective Deploy" ], "summary": "GetPolicySelectiveDeployStatus", "description": "Retrieves selective deploy operation status including per-device results. Shows which devices succeeded/failed for their atomic operation sets.", "operationId": "GetPolicySelectiveDeployStatus", "parameters": [ { "name": "selective_deploy_id", "in": "path", "description": "Selective deploy ID from the selective deploy operation", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicySelectiveDeployStatusResponse" }, { "description": "Response containing selective deploy operation status", "example": { "selective_deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } ] }, "example": { "selective_deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/selective_deploy/{selective_deploy_id}/devices/{device_id}": { "get": { "tags": [ "Policy Selective Deploy" ], "summary": "GetPolicySelectiveDeployResultByDevice", "description": "Retrieves selective deploy result for specific device, including deployed configuration and operation details.", "operationId": "GetPolicySelectiveDeployResultByDevice", "parameters": [ { "name": "selective_deploy_id", "in": "path", "description": "Selective deploy ID from the selective deploy operation", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "path", "description": "Device UUID", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/format1" }, { "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format" } ] } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPolicySelectiveDeployResultByDeviceResponse" }, { "description": "Response containing selective deploy result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } ] }, "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/selective_deploy": { "post": { "tags": [ "Policy Selective Deploy" ], "summary": "SelectiveDeploySingleNatPolicy", "description": "Deploy or undeploy a NAT policy to/from specific target entities (devices). A device must be assigned to the policy using the assignments API before deploying the policy to the device. Specify deploy_targets to deploy to specific devices/device groups, undeploy_targets to remove from specific devices/device groups. This is an asynchronous operation that returns a selective deploy ID for tracking the status of the deploy operation.", "operationId": "SelectiveDeploySingleNatPolicy", "parameters": [ { "name": "policy_id", "in": "path", "description": "UUID of the policy", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectiveDeployPolicyInput" }, { "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "unassign_on_undeploy": true } } ] }, "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "unassign_on_undeploy": true } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectiveDeployPolicyResponse" }, { "description": "Response for selective deploy operations", "example": { "selective_deploy_id": "string" } } ] }, "example": { "selective_deploy_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/firewall/{policy_uuid}/state": { "get": { "tags": [ "Policy State" ], "summary": "GetFirewallPolicyState", "description": "Retrieve the operational state of a firewall policy by its UUID. State indicates if the policy is deployed, pending deployment, or is partially deployed. Optionally, the API can also return the list of devices assigned to the policy along with their individual deployment states. GET api/v1/policies/firewall/550e8400-e29b-41d4-a716-446655440000/state?include_assigned_devices=true.", "operationId": "GetFirewallPolicyState", "parameters": [ { "name": "policy_uuid", "in": "path", "description": "The unique identifier of the firewall policy to retrieve state for.", "required": true, "schema": { "type": "string" } }, { "name": "include_assigned_devices", "in": "query", "description": "Include per-device deployment states in the response", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetFirewallPolicyStateResponse" }, { "description": "Deployment state of a firewall policy, including per-device deployment details", "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } } ] }, "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/state": { "get": { "tags": [ "Policy State" ], "summary": "GetNATPolicyState", "description": "Retrieve the operational state of a nat policy by its UUID.", "operationId": "GetNATPolicyState", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the nat policy to retrieve state for.", "required": true, "schema": { "type": "string" } }, { "name": "include_assigned_devices", "in": "query", "description": "Include per-device deployment states in the response", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetNatPolicyStateResponse" }, { "description": "Deployment state of a NAT policy, including per-device deployment details", "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } } ] }, "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions": { "get": { "tags": [ "Device Image Definitions" ], "summary": "ListDeviceImageDefinitions", "description": "Retrieve paginated list of images with details including version, platforms, and sha1_hash.", "operationId": "ListDeviceImageDefinitions", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: name(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Specific fields to include in the response for partial responses. Example: fields=uuid && fields=name", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains srx) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "obj_uuids", "in": "query", "description": "List of specific object UUIDs to retrieve. Example: obj_uuids=uuid1 && obj_uuids=uuid2", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListDeviceImageDefinitionsResponse" }, { "description": "Response containing list of images and total count", "example": { "items": [ { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "image_size": "string", "description": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "image_size": "string", "description": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "Device Image Definitions" ], "summary": "CreateDeviceImageDefinition", "description": "Adds a new image from a remote server URL. The image file is registered in the image repository.", "operationId": "CreateDeviceImageDefinition", "parameters": [], "requestBody": { "description": "Request to add a image from a remote server URL", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DeviceImageDefinitionsRequest" }, { "description": "Request to add a image from a remote server URL", "example": { "image_file_uri": "string", "sha1_hash": "string", "supported_platforms": [ "VSRX" ], "description": "string" } } ] }, "example": { "image_file_uri": "string", "sha1_hash": "string", "supported_platforms": [ "VSRX" ], "description": "string" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateDeviceImageDefinitionResponse" }, { "description": "Response containing the details of the newly created image", "example": { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "description": "string" } } ] }, "example": { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "description": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/deploy_image": { "post": { "tags": [ "Device Image Definitions" ], "summary": "BulkDeployImage", "description": "Deploy multiple software images to their respective device targets in a single request. This is an asynchronous operation that returns a deploy_image_id for tracking the status of the deploy image operation.", "operationId": "BulkDeployImage", "parameters": [], "requestBody": { "description": "Request containing multiple image-device deployment definitions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DeviceImageDefinitionsDeployImageRequest" }, { "description": "Request containing multiple image-device deployment definitions.", "example": { "device_image_definitions": [ { "uuid": "string", "targets": [ { "type": "DEVICE", "uuid": "string" } ] } ] } } ] }, "example": { "device_image_definitions": [ { "uuid": "string", "targets": [ { "type": "DEVICE", "uuid": "string" } ] } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkDeployImageResponse" }, { "description": "Response containing deploy job ID for the bulk deployment operation", "example": { "deploy_image_id": "string" } } ] }, "example": { "deploy_image_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/deploy_image/{deploy_image_id}": { "get": { "tags": [ "Device Image Definitions" ], "summary": "GetDeployImageStatus", "description": "Retrieve the status and results of an asynchronous deploy image operation using the deploy_image_id returned by DeployImage or BulkDeployImage.", "operationId": "GetDeployImageStatus", "parameters": [ { "name": "deploy_image_id", "in": "path", "description": "Unique identifier of the deploy job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDeployImageStatusResponse" }, { "description": "Response containing deploy job status and device results", "example": { "status": "FAILURE", "message": "string", "deploy_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "message": "string", "deploy_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/stage_image/{stage_image_id}": { "get": { "tags": [ "Device Image Definitions" ], "summary": "GetStageImageStatus", "description": "Retrieve the status and results of an asynchronous stage image operation using the stage_image_id returned by StageImage.", "operationId": "GetStageImageStatus", "parameters": [ { "name": "stage_image_id", "in": "path", "description": "Unique identifier of the stage job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetStageImageStatusResponse" }, { "description": "Response containing stage job status and device results", "example": { "status": "FAILURE", "message": "string", "stage_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } } ] }, "example": { "status": "FAILURE", "message": "string", "stage_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/{image_uuid}/deploy_image": { "post": { "tags": [ "Device Image Definitions" ], "summary": "DeployImage", "description": "Deploy a software image to one or more devices. This is an asynchronous operation that returns a deploy_image_id for tracking the status of the deploy image operation.", "operationId": "DeployImage", "parameters": [ { "name": "image_uuid", "in": "path", "description": "Unique identifier of the image to deploy", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body fields for the deploy operation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DeviceImageDefinitionsDeployImageRequest1" }, { "description": "Body fields for the deploy operation", "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } } ] }, "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeployImageResponse" }, { "description": "Response containing deploy job ID", "example": { "deploy_image_id": "string" } } ] }, "example": { "deploy_image_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/{image_uuid}/stage_image": { "post": { "tags": [ "Device Image Definitions" ], "summary": "StageImage", "description": "Stage a image on one or more devices. This is an asynchronous operation that returns a stage_image_id for tracking the status of the stage image operation.", "operationId": "StageImage", "parameters": [ { "name": "image_uuid", "in": "path", "description": "Unique identifier of the image to stage", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body fields for the stage operation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1DeviceImageDefinitionsStageImageRequest" }, { "description": "Body fields for the stage operation", "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } } ] }, "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/StageImageResponse" }, { "description": "Response containing stage job ID", "example": { "stage_image_id": "string" } } ] }, "example": { "stage_image_id": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/device_image_definitions/{uuid}": { "delete": { "tags": [ "Device Image Definitions" ], "summary": "DeleteDeviceImageDefinition", "description": "Delete a image by its UUID. Removes the image from the repository and associated storage.", "operationId": "DeleteDeviceImageDefinition", "parameters": [ { "name": "uuid", "in": "path", "description": "Unique identifier of the image to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/nat_pools": { "get": { "tags": [ "NAT Pools" ], "summary": "ListNatPools", "description": "Retrieve a paginated list of NAT Pools with optional filtering and sorting.", "operationId": "ListNatPools", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "filter", "in": "query", "description": "Filter expression to narrow results.\nIMPORTANT: String values must be enclosed in single quotes.\nExamples:\n (name eq 'my-pool')\n (name contains 'my-prefix')\n\nFilter expression applied to the result set. Supported fields: 'name'. String values must be enclosed in single quotes. Examples: \"(name eq 'my-pool')\" or \"(name contains 'my-prefix')\".", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Sort specification. Example: '(name(ascending))' or '(name(descending))'. Defaults to '(name(ascending))'.", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNatPoolsResponse" }, { "description": "Response containing a paginated list of NAT pools.", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } ], "count": "string" } } ] }, "example": { "items": [ { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "NAT Pools" ], "summary": "CreateNatPool", "description": "Create a new NAT Pool.", "operationId": "CreateNatPool", "parameters": [], "requestBody": { "description": "Request body for creating a NAT pool.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1NatPoolsRequest" }, { "description": "Request body for creating a NAT pool.", "example": { "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } ] }, "example": { "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPool" }, { "description": "Represents a complete NAT pool object.", "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } ] }, "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/nat_pools/{pool_id}": { "get": { "tags": [ "NAT Pools" ], "summary": "GetNatPool", "description": "Retrieve a single NAT Pool by its ID.", "operationId": "GetNatPool", "parameters": [ { "name": "pool_id", "in": "path", "description": "Identifier of the NAT pool.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPool" }, { "description": "Represents a complete NAT pool object.", "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } ] }, "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "NAT Pools" ], "summary": "DeleteNatPool", "description": "Delete a NAT Pool by its ID.", "operationId": "DeleteNatPool", "parameters": [ { "name": "pool_id", "in": "path", "description": "Identifier of the NAT pool to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "NAT Pools" ], "summary": "UpdateNatPool", "description": "Update an existing NAT Pool by its ID.", "operationId": "UpdateNatPool", "parameters": [ { "name": "pool_id", "in": "path", "description": "Identifier of the NAT pool to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "NAT pool fields to update (request body).", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1NatPoolsRequest" }, { "description": "NAT pool fields to update (request body).", "example": { "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } ] }, "example": { "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPool" }, { "description": "Represents a complete NAT pool object.", "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } ] }, "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat": { "get": { "tags": [ "NAT Policies" ], "summary": "ListNatPolicies", "description": "Retrieve a paginated list of NAT Policies with optional filtering and sorting.", "operationId": "ListNatPolicies", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression applied to the result set. Supported fields: 'name', 'id'. Supported operators: 'eq', 'contains'. String values must be enclosed in single quotes. Examples: \"(name eq 'my-pool')\", \"(name contains 'my-prefix')\", or \"(id eq 'pool-uuid').\"", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Sort specification. Example: '(name(ascending))' or '(name(descending))'. Defaults to '(order(ascending))'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNatPoliciesResponse" }, { "description": "Response containing list of NAT Policies", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } ], "count": "string" } } ] }, "example": { "items": [ { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "NAT Policies" ], "summary": "CreateNatPolicy", "description": "Create a new NAT policy with specified parameters.", "operationId": "CreateNatPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPolicyInput" }, { "example": { "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } ] }, "example": { "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPolicy" }, { "description": "Represents a complete NAT policy object", "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } ] }, "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{id}": { "get": { "tags": [ "NAT Policies" ], "summary": "GetNatPolicy", "description": "Retrieve a single NAT policy by its ID.", "operationId": "GetNatPolicy", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the NAT policy to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPolicy" }, { "description": "Represents a complete NAT policy object", "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } ] }, "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "NAT Policies" ], "summary": "DeleteNatPolicy", "description": "Delete a NAT policy by its ID.", "operationId": "DeleteNatPolicy", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the NAT policy to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "NAT Policies" ], "summary": "UpdateNatPolicy", "description": "Update an existing NAT policy. Modifies the NAT policy information including name, description, and configuration.", "operationId": "UpdateNatPolicy", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the NAT policy to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPolicyInput" }, { "example": { "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } ] }, "example": { "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatPolicy" }, { "description": "Represents a complete NAT policy object", "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } ] }, "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/arp_entries": { "get": { "tags": [ "NAT Policies" ], "summary": "GetArpEntries", "description": "Retrieve ARP entries for a NAT rule using only the required fields as query parameters. This is a lightweight alternative to the POST arp-entries endpoint that avoids sending the entire rule object in the payload.", "operationId": "GetArpEntries", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "nat_type", "in": "query", "description": "The NAT type for the rule.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT", "required": true, "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/nat_type1" }, { "description": "The NAT type for the rule.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT" } ] } }, { "name": "traffic_match_type", "in": "query", "description": "The traffic match type for source/destination matching.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching", "required": true, "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/traffic_match_type1" }, { "description": "The traffic match type for source/destination matching.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching" } ] } }, { "name": "address_ids", "in": "query", "description": "Translation object IDs such as pool IDs or address IDs.", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "rule_id", "in": "query", "description": "The unique identifier of the NAT rule within the policy.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "traffic_match_values", "in": "query", "description": "Traffic match values such as zone names, interface names, virtual router names, or routing group names.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "zone_sets", "in": "query", "description": "Zone set names. Required when traffic_match_type is ZONE.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetArpEntriesResponse" }, { "description": "Response containing ARP entries for the specified NAT rule parameters", "example": { "arp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } } ] }, "example": { "arp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/hierarchy": { "get": { "tags": [ "NAT Policies" ], "summary": "ListNatPolicyHierarchy", "description": "Retrieve a flat list of all rules and rule groups across the entire hierarchy of the specified NAT policy. This API traverses all nesting levels and returns every rule and rule group in a single response. Supports optional pagination and filtering on 'id' and 'name'. Response contains only the common attributes.", "operationId": "ListNatPolicyHierarchy", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier (UUID) of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). Defaults to 0.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page. Defaults to 1000 if not specified.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "filters", "in": "query", "description": "Filter expression applied to rules and rule groups. Supported fields: 'name', 'uuid'. Example: \"(name contains 'dmz')\".", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNatPolicyHierarchyResponse" }, { "description": "Response containing hierarchy of NAT policy rules and rule groups", "example": { "count": "string", "items": [ { "id": "string", "name": "string", "type": "string", "position": 1, "group_id": "string", "sequence_number": 1, "description": "string" } ] } } ] }, "example": { "count": "string", "items": [ { "id": "string", "name": "string", "type": "string", "position": 1, "group_id": "string", "sequence_number": 1, "description": "string" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/move_rules": { "post": { "tags": [ "NAT Policies" ], "summary": "MoveNatRules", "description": "Move one or more NAT rules to a different position within the policy or to a different rule group.", "operationId": "MoveNatRules", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy containing the rules to move.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MoveNatRulesInput" }, { "example": { "rule_ids": [ "string" ], "target_rule_group_id": "string", "position": 1 } } ] }, "example": { "rule_ids": [ "string" ], "target_rule_group_id": "string", "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNATRulesResponse" }, { "description": "Response containing list of NAT rules" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/proxy_ndp_entries": { "get": { "tags": [ "NAT Policies" ], "summary": "GetProxyNdpEntries", "description": "Retrieve Proxy NDP entries for a NAT rule using only the required fields as query parameters. This is a lightweight alternative to the POST proxy-ndp-entries endpoint that avoids sending the entire rule object in the payload.", "operationId": "GetProxyNdpEntries", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "nat_type", "in": "query", "description": "The NAT type for the rule.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT", "required": true, "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/nat_type1" }, { "description": "The NAT type for the rule.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT" } ] } }, { "name": "traffic_match_type", "in": "query", "description": "The traffic match type for source/destination matching.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching", "required": true, "style": "form", "explode": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/traffic_match_type1" }, { "description": "The traffic match type for source/destination matching.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching" } ] } }, { "name": "address_ids", "in": "query", "description": "Translation object IDs such as pool IDs or address IDs.", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "rule_id", "in": "query", "description": "The unique identifier of the NAT rule within the policy.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "traffic_match_values", "in": "query", "description": "Traffic match values such as zone names, interface names, virtual router names, or routing group names.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "zone_sets", "in": "query", "description": "Zone set names. Required when traffic_match_type is ZONE.", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetProxyNdpEntriesResponse" }, { "description": "Response containing Proxy NDP entries for the specified NAT rule parameters", "example": { "proxy_ndp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } } ] }, "example": { "proxy_ndp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rule_groups": { "get": { "tags": [ "NAT Policies" ], "summary": "ListNatRuleGroups", "description": "Retrieve a list of NAT rule groups within a policy.", "operationId": "ListNatRuleGroups", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNATRuleGroupsResponse" }, { "description": "Response containing list of NAT rule groups", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1 } ], "count": "string" } } ] }, "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1 } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "NAT Policies" ], "summary": "CreateNatRuleGroup", "description": "Create a new NAT rule group within a policy.", "operationId": "CreateNatRuleGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRuleGroupInput" }, { "example": { "name": "string", "description": "string", "position": 1 } } ] }, "example": { "name": "string", "description": "string", "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRuleGroup" }, { "description": "Represents a group of NAT rules within a policy", "example": { "id": "string", "name": "string", "description": "string", "position": 1 } } ] }, "example": { "id": "string", "name": "string", "description": "string", "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rule_groups/move": { "post": { "tags": [ "NAT Policies" ], "summary": "MoveNatRuleGroups", "description": "Move one or more NAT rule groups to a different position within the policy.", "operationId": "MoveNatRuleGroups", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy containing the rule groups to move.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MoveNatRuleGroupsInput" }, { "example": { "rule_group_id": "string", "position": 1 } } ] }, "example": { "rule_group_id": "string", "position": 1 } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNATRuleGroupsResponse" }, { "description": "Response containing list of NAT rule groups", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1 } ], "count": "string" } } ] }, "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1 } ], "count": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rule_groups/{group_id}": { "get": { "tags": [ "NAT Policies" ], "summary": "GetNatRuleGroup", "description": "Retrieve a single NAT rule group by its ID within a specific policy.", "operationId": "GetNatRuleGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRuleGroup" }, { "description": "Represents a group of NAT rules within a policy", "example": { "id": "string", "name": "string", "description": "string", "position": 1 } } ] }, "example": { "id": "string", "name": "string", "description": "string", "position": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "NAT Policies" ], "summary": "DeleteNatRuleGroup", "description": "Delete a NAT rule group within a policy.", "operationId": "DeleteNatRuleGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group to delete.", "required": true, "schema": { "type": "string" } }, { "name": "ungroup_rules", "in": "query", "description": "Default value is false. If set to true, the rule group will be deleted and the rules inside it will be ungrouped and moved to the policy level", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rule_groups/{group_id}/rules": { "get": { "tags": [ "NAT Policies" ], "summary": "ListNatRulesInGroup", "description": "Retrieve a list of NAT rules within a specific rule group.", "operationId": "ListNatRulesInGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression applied to the result set. Supported fields: 'name', 'id'. Supported operators: 'eq', 'contains'. String values must be enclosed in single quotes. Examples: \"(name eq 'my-pool')\", \"(name contains 'my-prefix')\", or \"(id eq 'pool-uuid').\"", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Sort specification. Supported fields: 'id','name', 'sequence_number'. Example: '(name(ascending))' or '(name(descending))'. Defaults to '(sequence_number(ascending))'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNATRulesResponse" }, { "description": "Response containing list of NAT rules" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "NAT Policies" ], "summary": "CreateNatRuleInGroup", "description": "Create a new NAT rule within a rule group.", "operationId": "CreateNatRuleInGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NatRuleInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rule_groups/{group_id}/rules/{rule_id}": { "get": { "tags": [ "NAT Policies" ], "summary": "GetNatRuleInGroup", "description": "Retrieve a single NAT rule by its ID within a specific rule group.", "operationId": "GetNatRuleInGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "NAT Policies" ], "summary": "DeleteNatRuleInGroup", "description": "Delete a NAT rule within a rule group.", "operationId": "DeleteNatRuleInGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "NAT Policies" ], "summary": "UpdateNatRuleInGroup", "description": "Update an existing NAT rule within a rule group.", "operationId": "UpdateNatRuleInGroup", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "group_id", "in": "path", "description": "The unique identifier of the NAT rule group.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NatRuleInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rules": { "get": { "tags": [ "NAT Policies" ], "summary": "ListNatRules", "description": "Retrieve a flat list of all rules across the entire hierarchy of the specified NAT policy. This API traverses all nesting levels and returns every rule in a single response. Supports optional pagination and filtering on 'id' and 'name'. Response contains complete rule details.", "operationId": "ListNatRules", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression applied to the result set. Supported fields: 'name', 'id'. Supported operators: 'eq', 'contains'. String values must be enclosed in single quotes. Examples: \"(name eq 'my-pool')\", \"(name contains 'my-prefix')\", or \"(id eq 'pool-uuid').\"", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Sort specification. Supported fields: 'id','name', 'sequence_number'. Example: '(name(ascending))' or '(name(descending))'. Defaults to '(sequence_number(ascending))'.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "If true, the response will include only the total number of matching resources, without returning the resource details. If false (default), the response will include both the total count and the details of the matching resources.", "style": "form", "explode": true, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListNATRulesResponse" }, { "description": "Response containing list of NAT rules" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "post": { "tags": [ "NAT Policies" ], "summary": "CreateNatRule", "description": "Create a new NAT rule within a policy.", "operationId": "CreateNatRule", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NatRuleInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/policies/nat/{policy_id}/rules/{rule_id}": { "get": { "tags": [ "NAT Policies" ], "summary": "GetNatRule", "description": "Retrieve a single NAT rule by its ID within a specific policy.", "operationId": "GetNatRule", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "delete": { "tags": [ "NAT Policies" ], "summary": "DeleteNatRule", "description": "Delete a NAT rule within a policy.", "operationId": "DeleteNatRule", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": {} }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false }, "put": { "tags": [ "NAT Policies" ], "summary": "UpdateNatRule", "description": "Update an existing NAT rule within a policy.", "operationId": "UpdateNatRule", "parameters": [ { "name": "policy_id", "in": "path", "description": "The unique identifier of the NAT policy.", "required": true, "schema": { "type": "string" } }, { "name": "rule_id", "in": "path", "description": "The unique identifier of the NAT rule to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NatRuleInput" } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NatRule" }, { "description": "Represents a single NAT rule within a policy" } ] } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/googlerpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "ListSubscriptions", "description": "List subscriptions with pagination and filtering.", "operationId": "ListSubscriptions", "parameters": [ { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based). If not provided, the default is 0.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "size", "in": "query", "description": "The maximum number of results to return per page. If set to zero, the API will attempt to return the maximum number of records allowed by its limits.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: ((name contains foo) and (uuid eq 342dc767-fd4e-4c40-a969-3adaf690e232)).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Sort order expression (e.g. (updated_timestamp(descending)))", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSubscriptionsResponse" }, { "example": { "items": [ { "uuid": "string", "product_SKU": "string", "ssrn": "string", "activation_code": "string", "start_date_int": "string", "end_date_int": "string", "duration": "string", "cust_contract_status": "string", "contract_status": "string", "type": "string", "subscription_name": "string", "entitlement": [ "string" ], "sku_type": "string", "sku_identifier": 1, "available_qty": "string", "activated_qty": "string" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "product_SKU": "string", "ssrn": "string", "activation_code": "string", "start_date_int": "string", "end_date_int": "string", "duration": "string", "cust_contract_status": "string", "contract_status": "string", "type": "string", "subscription_name": "string", "entitlement": [ "string" ], "sku_type": "string", "sku_identifier": 1, "available_qty": "string", "activated_qty": "string" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/subscriptions/{subscription_uuid}/associations": { "get": { "tags": [ "Subscriptions" ], "summary": "ListSubscriptionAssociations", "description": "Returns the list of devices associated with a subscription identified by its UUID.", "operationId": "ListSubscriptionAssociations", "parameters": [ { "name": "subscription_uuid", "in": "path", "description": "UUID of the subscription", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Starting index for pagination (zero-based).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "Maximum number of results to return per page.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filters", "in": "query", "description": "Filter expression to narrow results. Supports operators: eq, ne, contains, excludes. Combine with and/or. Example: (id eq 334f3b76-ef25-47e0-b743-c4db93a017b0).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sortby", "in": "query", "description": "Field and direction to sort results. Format: field(ascending) or field(descending). Example: id(ascending).", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ListSubscriptionAssociationsResponse" }, { "description": "List of devices associated with a subscription", "example": { "items": [ { "uuid": "string", "type": "DEVICE" } ], "count": 1 } } ] }, "example": { "items": [ { "uuid": "string", "type": "DEVICE" } ], "count": 1 } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } }, "/api/v1/subscriptions/{subscription_uuid}/associations/create": { "post": { "tags": [ "Subscriptions" ], "summary": "AssociateSubscription", "description": "Associates a subscription, identified by its UUID, with one or more devices. This API is used to monitor the health status of the device(s).", "operationId": "AssociateSubscription", "parameters": [ { "name": "subscription_uuid", "in": "path", "description": "UUID of the subscription", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiV1SubscriptionsAssociationsCreateRequest" }, { "description": "Request body", "example": { "targets": [ { "id": "string", "type": "DEVICE" } ] } } ] }, "example": { "targets": [ { "id": "string", "type": "DEVICE" } ] } } }, "required": true }, "responses": { "200": { "description": "A successful response.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "example": { "example": "string" } }, "example": { "example": "string" } } } }, "400": { "description": "Invalid request parameters. The request could not be understood or was missing required parameters.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "401": { "description": "Authentication required. The request requires valid user authentication credentials.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "403": { "description": "Forbidden. The client does not have access rights to the content.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "404": { "description": "Resource not found. The requested resource could not be found.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "409": { "description": "Conflict. The request could not be completed due to a conflict with the current state of the resource. This may occur when an object with the same name already exists in the system.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "429": { "description": "Resource exhausted. The request was rejected because a resource limit has been reached. This may occur due to rate limiting (too many requests in a given time period) or because the response payload size exceeds the maximum allowed threshold. Consider reducing the scope of the request, applying filters, or using pagination to retrieve smaller result sets.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "500": { "description": "Internal processing error. An unexpected error occurred on the server.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runtimeError1" } } } }, "default": { "description": "An unexpected error response.", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/rpcStatus" }, { "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } ] }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } } } } }, "deprecated": false } } }, "components": { "schemas": { "ChangePasswordResponseChangePasswordStatus": { "title": "ChangePasswordResponseChangePasswordStatus", "enum": [ "SUCCESS", "INVALID" ], "type": "string", "example": "SUCCESS" }, "iamChangePasswordRequest": { "title": "iamChangePasswordRequest", "type": "object", "properties": { "email": { "type": "string" }, "current_password": { "type": "string" }, "new_password": { "type": "string" } }, "example": { "email": "string", "current_password": "string", "new_password": "string" } }, "iamChangePasswordResponse": { "title": "iamChangePasswordResponse", "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/ChangePasswordResponseChangePasswordStatus" }, { "example": "SUCCESS" } ] } }, "example": { "status": "SUCCESS" } }, "iamCreateUserRPCResponse": { "title": "iamCreateUserRPCResponse", "type": "object", "properties": { "uuid": { "type": "string" } }, "example": { "uuid": "string" } }, "iamDeleteUserRPCResponse": { "title": "iamDeleteUserRPCResponse", "type": "object", "properties": { "uuid": { "type": "string" } }, "example": { "uuid": "string" } }, "iamEditUserResponse": { "title": "iamEditUserResponse", "type": "object", "properties": { "uuid": { "type": "string" } }, "example": { "uuid": "string" } }, "iamEnableOption": { "title": "iamEnableOption", "type": "object", "properties": { "enable": { "type": "boolean" } }, "example": { "enable": true } }, "iamGetTokenScopeResponse": { "title": "iamGetTokenScopeResponse", "type": "object", "properties": { "tenant_id": { "type": "string", "description": "ID of the tenant associated with the request." } }, "example": { "tenant_id": "string" } }, "iamRoleAssignment": { "title": "iamRoleAssignment", "type": "object", "properties": { "scope_id": { "type": "string", "description": "ID of the scope on which the role has to be assigned." }, "scope_name": { "type": "string", "description": "Name of the scope on which the role has to be assigned." }, "scope_group_id": { "type": "string", "description": "ID of the scope group on which the role has to be assigned." }, "scope_group_name": { "type": "string", "description": "Name of the scope group on which the role has to be assigned." }, "role_id": { "type": "string" }, "role_name": { "type": "string" } }, "example": { "scope_id": "string", "scope_name": "string", "scope_group_id": "string", "scope_group_name": "string", "role_id": "string", "role_name": "string" } }, "iamSendEmailRequest": { "title": "iamSendEmailRequest", "type": "object", "properties": { "email": { "type": "string", "description": "Mandatory: Email of the user for which the activation email will be sent." } }, "example": { "email": "string" } }, "CreateUserRequest": { "title": "CreateUserRequest", "type": "object", "properties": { "user_name": { "type": "string", "description": "Mandatory: User name(email)." }, "first_name": { "type": "string", "description": "Mandatory: User first name." }, "last_name": { "type": "string", "description": "Mandatory: User last name." }, "enable_option": { "allOf": [ { "$ref": "#/components/schemas/iamEnableOption" }, { "example": { "enable": true } } ] }, "role_assignments": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignment" }, "description": "Mandatory: Roles assigned on Scope or Scope Group." }, "user_properties": { "allOf": [ { "$ref": "#/components/schemas/iamUserProperties" }, { "example": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } ] } }, "example": { "user_name": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "role_id": "string", "role_name": "string" } ], "user_properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } }, "EditUserRequest": { "title": "EditUserRequest", "type": "object", "properties": { "user_id": { "type": "string", "description": "Mandatory: User UUID." }, "first_name": { "type": "string", "description": "Optional: User first name." }, "last_name": { "type": "string", "description": "Optional: User last name." }, "enable_option": { "allOf": [ { "$ref": "#/components/schemas/iamEnableOption" }, { "example": { "enable": true } } ] }, "role_assignments": { "type": "array", "items": { "$ref": "#/components/schemas/iamRoleAssignment" }, "description": "Optional: Roles assigned on Scope or Scope Group." }, "properties": { "allOf": [ { "$ref": "#/components/schemas/iamUserProperties" }, { "example": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } ] } }, "example": { "user_id": "string", "first_name": "string", "last_name": "string", "enable_option": { "enable": true }, "role_assignments": [ { "scope_id": "string", "scope_name": "string", "scope_group_id": "string", "scope_group_name": "string", "role_id": "string", "role_name": "string" } ], "properties": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } } }, "GetRoleResponse": { "title": "GetRoleResponse", "type": "object", "properties": { "role": { "allOf": [ { "$ref": "#/components/schemas/RoleInfo" }, { "example": { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } } ] } }, "example": { "role": { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } } }, "GetUserResponse": { "title": "GetUserResponse", "type": "object", "properties": { "user_info": { "allOf": [ { "$ref": "#/components/schemas/UserInfo" }, { "example": { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } } ] } }, "example": { "user_info": { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } } }, "ListRolesResponse": { "title": "ListRolesResponse", "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleInfo" }, "description": "List of role information." }, "role_count": { "type": "string", "description": "Max number of roles present in system." } }, "example": { "roles": [ { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } ], "role_count": "string" } }, "ListUsersResponse": { "title": "ListUsersResponse", "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserInfo" }, "description": "List of users." }, "user_count": { "type": "string", "description": "Total number of users present in the system." } }, "example": { "users": [ { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } ], "user_count": "string" } }, "PagingSpec": { "title": "PagingSpec", "type": "object", "properties": { "size": { "type": "string", "description": "Max number of entries to fetch." }, "from": { "type": "string", "description": "Starting offset of entries to fetch." } }, "example": { "size": "string", "from": "string" } }, "RoleAssignment": { "title": "RoleAssignment", "type": "object", "properties": { "scope_id": { "type": "string", "description": "Mandatory: ID of the scope on which the role has to be assigned." }, "role_id": { "type": "string", "description": "Mandatory: ID of the role on the scope." }, "role_name": { "type": "string", "description": "Optional: Name of the role on the scope. Either role_id or role_name is necessary." } }, "example": { "scope_id": "string", "role_id": "string", "role_name": "string" } }, "RoleInfo": { "title": "RoleInfo", "type": "object", "properties": { "UUID": { "type": "string", "description": "ID of the role." }, "name": { "type": "string", "description": "Name of the role." }, "capabilities": { "type": "array", "items": { "type": "string" }, "description": "Capabilities of the role." }, "predefined": { "type": "boolean", "description": "Is this role predefined." } }, "example": { "UUID": "string", "name": "string", "capabilities": [ "string" ], "predefined": true } }, "UserInfo": { "title": "UserInfo", "type": "object", "properties": { "user_id": { "type": "string", "description": "UUID of the user." }, "email": { "type": "string", "description": "Email of the user." }, "name": { "type": "string", "description": "Name of the user." }, "status": { "type": "string", "description": "Status of the user." }, "last_login": { "type": "string", "description": "Last login time of the user." }, "role": { "type": "array", "items": { "$ref": "#/components/schemas/UserRole" }, "description": "Role assigned to the user." } }, "example": { "user_id": "string", "email": "string", "name": "string", "status": "string", "last_login": "string", "role": [ { "role_name": "string" } ] } }, "UserRole": { "title": "UserRole", "type": "object", "properties": { "role_name": { "type": "string", "description": "Name of the role assigned to user." } }, "example": { "role_name": "string" } }, "iamUserProperties": { "title": "iamUserProperties", "type": "object", "properties": { "company_name": { "type": "string", "description": "user Company Name." }, "phone_number": { "type": "string", "description": "user Phone Number." }, "address": { "type": "string", "description": "user Address." }, "city": { "type": "string", "description": "user City." }, "state": { "type": "string", "description": "user State." }, "country": { "type": "string", "description": "user Country." }, "zipcode": { "type": "string", "description": "user Zip Code." } }, "example": { "company_name": "string", "phone_number": "string", "address": "string", "city": "string", "state": "string", "country": "string", "zipcode": "string" } }, "protobufAny": { "title": "protobufAny", "type": "object", "properties": { "typeUrl": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type." } }, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "example": { "typeUrl": "string", "value": "string" } }, "runtimeError": { "title": "runtimeError", "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny" }, "description": "" } }, "example": { "error": "string", "code": 1, "message": "string", "details": [ { "typeUrl": "string", "value": "string" } ] } }, "CreateIpsecProfile": { "title": "CreateIpsecProfile", "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/CreateIpsecProfileProfile" } }, "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } } }, "GetTenantPopListResponse": { "title": "GetTenantPopListResponse", "type": "object", "properties": { "max_users": { "type": "string", "description": "Maximum number of users that is possible in this service location." }, "avail_users": { "type": "string", "description": "Number of current users of this service location." } }, "example": { "max_users": "string", "avail_users": "string" } }, "fapiprotoIkeAuthAlgorithm": { "title": "fapiprotoIkeAuthAlgorithm", "enum": [ "IKE_AUTH_ALGO_NONE", "SHA_256", "SHA_384", "SHA_512" ], "type": "string", "description": "Authentication algorithm for IKE protocol.", "example": "IKE_AUTH_ALGO_NONE" }, "fapiprotoIkeAuthMethod": { "title": "fapiprotoIkeAuthMethod", "enum": [ "IKE_AUTH_METHOD_NONE", "PSK", "ECDSA_256", "ECDSA_384", "ECDSA_521", "RSA" ], "type": "string", "description": "Authentication method for IKE protocol.", "example": "IKE_AUTH_METHOD_NONE" }, "fapiprotoIkeDhGroup": { "title": "fapiprotoIkeDhGroup", "enum": [ "GROUP_NONE", "GROUP_14", "GROUP_15", "GROUP_16", "GROUP_19", "GROUP_20", "GROUP_21", "GROUP_24" ], "type": "string", "description": "DH group for IKE protocol.", "example": "GROUP_NONE" }, "fapiprotoIkeDpdOption": { "title": "fapiprotoIkeDpdOption", "enum": [ "IKE_DPD_OPT_NONE", "ALWAYS_SEND", "OPTIMIZED", "PROBE_IDLE" ], "type": "string", "description": "DPD (dead-peer-detection) of IKE protocol.", "example": "IKE_DPD_OPT_NONE" }, "fapiprotoIkeEncryptAlgorithm": { "title": "fapiprotoIkeEncryptAlgorithm", "enum": [ "IKE_ENCR_ALGO_NONE", "AES_128_CBC", "AES_128_GCM", "AES_192_CBC", "AES_192_GCM", "AES_256_CBC", "AES_256_GCM" ], "type": "string", "description": "Encryption algorithm for IKE protocol.", "example": "IKE_ENCR_ALGO_NONE" }, "fapiprotoIkeMode": { "title": "fapiprotoIkeMode", "enum": [ "IKE_MODE_NONE", "MAIN", "AGGRESSIVE" ], "type": "string", "description": "Mode of IKE protocol.", "example": "IKE_MODE_NONE" }, "fapiprotoIpsecAuthAlgorithm": { "title": "fapiprotoIpsecAuthAlgorithm", "enum": [ "IPSEC_AUTH_ALGO_NONE", "HMAC_SHA_256_128", "HMAC_SHA_384", "HMAC_SHA_512" ], "type": "string", "description": "Authentication algorithm for IPSEC protocol.", "example": "IPSEC_AUTH_ALGO_NONE" }, "establishoption": { "title": "establishoption", "enum": [ "IPSEC_EST_OPTION_NONE", "IMMEDIATELY", "ON_TRAFFIC", "RESPONDER_ONLY", "RESPONDER_ONLY_NO_REKEY" ], "type": "string", "example": "IPSEC_EST_OPTION_NONE" }, "fapiprotoIpsecProfile": { "title": "fapiprotoIpsecProfile", "type": "object", "properties": { "profile_name": { "type": "string", "description": "Important: Name of the profile." }, "description": { "type": "string", "description": "Description of the profile." }, "ike_auth_method": { "$ref": "#/components/schemas/fapiprotoIkeAuthMethod" }, "ike_dh_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ike_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeAuthAlgorithm" }, "ike_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ike_lifetime": { "type": "integer", "description": "Important: Lifetime in seconds for the IPsec proposal.", "format": "int64" }, "ipsec_protocol": { "$ref": "#/components/schemas/fapiprotoIpsecProtocol" }, "ipsec_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIpsecAuthAlgorithm" }, "ipsec_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ipsec_lifetime": { "type": "integer", "description": "Important: Lifetime for Ipsec proposal.", "format": "int64" }, "ike_mode": { "$ref": "#/components/schemas/fapiprotoIkeMode" }, "ike_version": { "type": "string", "description": "Version for Ike gateway." }, "ike_dpd_enable": { "type": "boolean", "description": "To require DPD for Ike gateway to detect if a peer is dead or not." }, "ike_dpd_option": { "$ref": "#/components/schemas/fapiprotoIkeDpdOption" }, "ike_dpd_interval": { "type": "integer", "description": "Deprecated: Interval for Ike gateway.", "format": "int64" }, "ike_dpd_threshold": { "type": "integer", "description": "Deprecated: Threshold for Ike gateway.", "format": "int64" }, "ipsec_pfs_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ipsec_establish_option": { "allOf": [ { "$ref": "#/components/schemas/establishoption" }, { "example": "IPSEC_EST_OPTION_NONE" } ] } }, "description": "Info of an ipsec profile.", "example": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" } }, "fapiprotoIpsecProtocol": { "title": "fapiprotoIpsecProtocol", "enum": [ "IPSEC_PROTOCOL_NONE", "ESP", "AH" ], "type": "string", "description": "IPSEC protocol.", "example": "IPSEC_PROTOCOL_NONE" }, "MistConfiguration": { "title": "MistConfiguration", "type": "object", "properties": { "pre_shared_key": { "type": "string", "description": "The pre shared key for the CPE device. This is available only when you select IPsec as the tunnel type during site creation." }, "local_identity": { "type": "string", "description": "This is the IKE ID or the domain of the site." }, "primary": { "allOf": [ { "$ref": "#/components/schemas/TunnelConfig" }, { "example": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] }, "secondary": { "allOf": [ { "$ref": "#/components/schemas/TunnelConfig" }, { "example": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] }, "ike_proposal": { "allOf": [ { "$ref": "#/components/schemas/ProposalConfig" }, { "example": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" } } ] }, "ipsec_proposal": { "allOf": [ { "$ref": "#/components/schemas/ProposalConfig" }, { "example": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" } } ] }, "tunnel_pair": { "type": "array", "items": { "$ref": "#/components/schemas/fapiprotoTunnelPair" }, "description": "Configuration for a device may have multiple pri/sec tunnels. tunnel_pair is to express all the tunnels. primaryTunnel and secondaryTunnel are deprecated." } }, "example": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ { "primary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] } }, "ProposalConfig": { "title": "ProposalConfig", "type": "object", "properties": { "authentication_method": { "type": "string", "description": "The authentication method of the proposal." }, "dh_group": { "type": "string", "description": "The DH group of the proposal." }, "encryption_algorithm": { "type": "string", "description": "The encryption algorithm of the proposal." }, "protocol": { "type": "string", "description": "Protocol of the proposal." }, "pfs_group": { "type": "string", "description": "PFS group of the proposal." }, "lifetime_seconds": { "type": "string", "description": "Lifetime of the proposal." } }, "example": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" } }, "fapiprotoStatus": { "title": "fapiprotoStatus", "enum": [ "NO_STATUS", "STARTED", "IN_PROGRESS", "SUCCESS", "FAILED", "PENDING", "CREATE_IN_PROGRESS", "DEPLOY_READY" ], "type": "string", "description": "State of an operation.", "example": "NO_STATUS" }, "TunnelConfig": { "title": "TunnelConfig", "type": "object", "properties": { "address": { "type": "string", "description": "remote address of jsec device." }, "remote_identity": { "type": "string", "description": "This is the ID of the vSRX device and can be used for establishing a connection or a separate tunnel." }, "probe_source_ip": { "type": "string", "description": "This is the source IP address assigned to a tunnel created in the presence of an external probe." }, "local_identity": { "type": "string", "description": "This is the IKE ID or the domain of the site." } }, "example": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } }, "fapiprotoTunnelPair": { "title": "fapiprotoTunnelPair", "type": "object", "properties": { "primary_tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelConfig" }, { "example": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] }, "secondary_tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelConfig" }, { "example": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] } }, "example": { "primary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } }, "fapiprotoTunnelStatus": { "title": "fapiprotoTunnelStatus", "enum": [ "TS_NONE", "TS_NOT_MONITORED", "TS_UP", "TS_DOWN" ], "type": "string", "example": "TS_NONE" }, "Typeoftunnel": { "title": "Typeoftunnel", "enum": [ "TYPE_NA", "TYPE_GRE", "TYPE_IPSEC" ], "type": "string", "example": "TYPE_NA" }, "CPEDevice": { "title": "CPEDevice", "type": "object", "properties": { "name": { "type": "string", "description": "Mandatory: Name of CPE device." }, "psk": { "type": "string", "description": "Mandatory: The Pre-shared key to authenticate the remote access user. The key should be minimum 6 characters with at least one lower case, one upper case, one number and one special character. This is needed only if the cpe_interfaces.tunnel_type is of IPSEC type (i.e it is of value 2)." }, "configured_unit_number": { "type": "string", "description": "Mandatory: This tunnel seed number is the offset for Junos OS CLI tunnel interface identifiers. Allowed range: 1-1000. The first tunnel interface is assigned configured_unit_number + 1 designator, and the second tunnel interface is assigned configured_unit_number + 2 designator." }, "trust_zone": { "type": "string", "description": "Mandatory: Enter the zone type for the tunnel security- trust or untrust. This should be of value trust if you want to use the default trust zone. More on zones at https://www.juniper.net/documentation/us/en/software/junos/security-policies/topics/topic-map/security-zone-configuration.html ." }, "untrust_zone": { "type": "string", "description": "Mandatory: Enter the zone type for the external interface- trust or untrust. This should be of value untrust if you want to use the default untrust zone. More on zones at https://www.juniper.net/documentation/us/en/software/junos/security-policies/topics/topic-map/security-zone-configuration.html ." }, "tunnel_routing_instance": { "type": "string", "description": "Optional: Enter the routing instance name that contains the tunnel destination address. This will use the default routing instance if left blank. More on routing instances at https://www.juniper.net/documentation/us/en/software/junos/routing-overview/topics/concept/routing-instances-overview.html ." }, "ipsec_profile_name": { "type": "string", "description": "Mandatory: Name of the IPsec profile to use for the device. This option is needed only when you select IPsec as the tunnel type. Information on IPsec profiles can be found using API GET /api/v2/ipsec-profiles." }, "cpe_interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/CPEInterface" }, "description": "Mandatory: List of CPEInterfaces." }, "cpe_type": { "type": "string", "description": "Mandatory: Type of CPE device. Enter vSRX here." }, "use_site_secondary": { "type": "boolean", "description": "Optional: Use site's secondary tenant-pop as CPE's primary tenant-pop." }, "skip_tunnel_cfg": { "type": "boolean", "description": "Optional: Enable Skip CPE Configuration when configuring a CP device using Mist, a Juniper Session Smart Router in Juniper's SD-WAN solution, or a third-party CPE device. When you enable Skip CPE Configuration, the CPE routing configuration is not generated." } }, "example": { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } }, "CPEInterface": { "title": "CPEInterface", "type": "object", "properties": { "ip_address": { "type": "string", "description": "Mandatory: Enter the IP address of the CPE side interface here. This is needed if cpe_interfaces.ip_address_type is static or if tunnel_type is 1." }, "ike_id": { "type": "string", "description": "Mandatory: If cpe_interfaces.ip_address_type is dynamic, enter the IKE(Internet key exchange) ID of the site here." }, "external_interface_name": { "type": "string", "description": "Mandatory: The name of the external interface. An external interface connects your device to the Internet/network. This should match the name of the physical interface on the CPE(eg: gr-0/0/1.0). If you want to use the default value, enter ge-0/0/0.0." }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/Typeoftunnel" }, { "example": "TYPE_NA" } ] }, "tunnel_interface": { "type": "string", "description": "Optional: Interface Name to assign to the tunnel." }, "ip_address_type": { "type": "string", "description": "Mandatory: Must be one of the values Static or Dynamic. This is needed only if cpe_interfaces.tunnel_type is 2." }, "name": { "type": "string", "description": "Mandatory: Name of CPE interface." } }, "example": { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } }, "CPEInterfaceList": { "title": "CPEInterfaceList", "type": "object", "properties": { "ike_id": { "type": "string", "description": "IKE(Internet key exchange) Id of tunnel interface." }, "ip_address": { "type": "string", "description": "The IP address of the CPE side interface. This is present if cpe_interfaces.ip_address_type is static or if tunnel_type is 1." }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/Typeoftunnel" }, { "example": "TYPE_NA" } ] }, "external_interface_name": { "type": "string", "description": "Name of external interface. An external interface connects your device to the Internet/network." }, "tunnel_interface": { "type": "string", "description": "Interface name under the tunnel." }, "site_config": { "allOf": [ { "$ref": "#/components/schemas/Configuration" }, { "example": { "body": "string", "format": "string" } } ] }, "tunnel_info": { "type": "array", "items": { "$ref": "#/components/schemas/TunnelInfo" }, "description": "Information on a list of tunnels." }, "ip_address_type": { "type": "string", "description": "Type of the interface’s IP address .Is one of these values i.e Static or Dynamic." }, "name": { "type": "string", "description": "Name of CPE interface." } }, "example": { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ { "primary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" }, "secondary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } ], "ip_address_type": "string", "name": "string" } }, "CPEList": { "title": "CPEList", "type": "object", "properties": { "name": { "type": "string", "description": "Name of CPE device." }, "ipsec_profile_name": { "type": "string", "description": "Name of the IPsec profile used for the device. Information on IPsec profiles can be found using API GET /api/v2/ipsec-profiles." }, "tunnel_interface": { "type": "string", "description": "Deprecated: Interface IP of tunnel." }, "trust_zone": { "type": "string", "description": "The trust zone name that contains the zone configuration. This is of value trust if the default trust zone is used. More on zones at https://www.juniper.net/documentation/us/en/software/junos/security-policies/topics/topic-map/security-zone-configuration.html ." }, "cpe_interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/CPEInterfaceList" }, "description": "List of CPEInterfaces." }, "psk": { "type": "string", "description": "The pre shared key for the CPE device. This is available only when you select IPsec as the tunnel type." }, "configured_unit_number": { "type": "string", "description": "This tunnel seed number is the offset for Junos OS CLI tunnel interface identifiers. Allowed range: 1-1000. The first tunnel interface is assigned configured_unit_number + 1 designator, and the second tunnel interface is assigned configured_unit_number + 2 designator." }, "untrust_zone": { "type": "string", "description": "The untrust zone name that contains the zone configuration. This is of value untrust if the default untrust zone is used. More on zones at https://www.juniper.net/documentation/us/en/software/junos/security-policies/topics/topic-map/security-zone-configuration.html ." }, "unit_number": { "type": "string", "description": "Unit number of device." }, "tunnel_routing_instance": { "type": "string", "description": "The routing instance name that contains the tunnel configuration. This will use the default routing instance if blank. More on routing instances at https://www.juniper.net/documentation/us/en/software/junos/routing-overview/topics/concept/routing-instances-overview.html ." }, "cpe_type": { "type": "string", "description": "Type of CPE device." }, "use_site_secondary": { "type": "boolean", "description": "If site's secondary tenant-pop is the CPE's primary tenant-pop, this is true." }, "skip_tunnel_cfg": { "type": "boolean", "description": "If tunnel configuration was skipped upon site creation, this is true." }, "cpe_config": { "allOf": [ { "$ref": "#/components/schemas/Configuration" }, { "example": { "body": "string", "format": "string" } } ] }, "mist_config": { "allOf": [ { "$ref": "#/components/schemas/MistConfiguration" }, { "example": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ { "primary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] } } ] } }, "example": { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ { "primary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" }, "secondary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } ], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ { "primary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary_tunnel": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" } } ] } } }, "Configuration": { "title": "Configuration", "type": "object", "properties": { "body": { "type": "string", "description": "Configuration body." }, "format": { "type": "string", "description": "Configuration format." } }, "example": { "body": "string", "format": "string" } }, "CreateBulkSiteRequest": { "title": "CreateBulkSiteRequest", "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/Site" }, "description": "Mandatory: List of sites to create." } }, "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } }, "CreateSiteRequest": { "title": "CreateSiteRequest", "type": "object", "properties": { "site": { "allOf": [ { "$ref": "#/components/schemas/Site" }, { "example": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } ] } }, "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } } }, "ExternalProbe": { "title": "ExternalProbe", "type": "object", "properties": { "probe_address": { "type": "string", "description": "Address of the external probe." }, "ping_source_subnet": { "type": "string", "description": "Source IPv4 address subnet and mask for the external probe. Be sure to select a large enough source subnet that can support all your CPE devices in your network." } }, "example": { "probe_address": "string", "ping_source_subnet": "string" } }, "ExternalProbeRequest": { "title": "ExternalProbeRequest", "type": "object", "properties": { "external_probe": { "allOf": [ { "$ref": "#/components/schemas/ExternalProbe" }, { "example": { "probe_address": "string", "ping_source_subnet": "string" } } ] } }, "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } }, "GetExternalProbeResponse": { "title": "GetExternalProbeResponse", "type": "object", "properties": { "external_probe": { "allOf": [ { "$ref": "#/components/schemas/ExternalProbe" }, { "example": { "probe_address": "string", "ping_source_subnet": "string" } } ] } }, "example": { "external_probe": { "probe_address": "string", "ping_source_subnet": "string" } } }, "GetIpsecProfileListResponse": { "title": "GetIpsecProfileListResponse", "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/GetIpsecProfileResponse" }, "description": "List of Ipsec profiles." }, "total": { "type": "integer", "description": "Total count of ipsec profiles in system.", "format": "int64" } }, "example": { "profiles": [ { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } ], "total": 1 } }, "GetIpsecProfileResponse": { "title": "GetIpsecProfileResponse", "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/GetIpsecProfileResponseProfile" }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/Configuration" }, "description": "List of ip sec profile configurations." } }, "example": { "profile": { "profile_name": "string", "description": "string", "ike_auth_method": "IKE_AUTH_METHOD_NONE", "ike_dh_group": "GROUP_NONE", "ike_auth_algorithm": "IKE_AUTH_ALGO_NONE", "ike_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ike_lifetime": 1, "ipsec_protocol": "IPSEC_PROTOCOL_NONE", "ipsec_auth_algorithm": "IPSEC_AUTH_ALGO_NONE", "ipsec_encrypt_algorithm": "IKE_ENCR_ALGO_NONE", "ipsec_lifetime": 1, "ike_mode": "IKE_MODE_NONE", "ike_version": "string", "ike_dpd_enable": true, "ike_dpd_option": "IKE_DPD_OPT_NONE", "ike_dpd_interval": 1, "ike_dpd_threshold": 1, "ipsec_pfs_group": "GROUP_NONE", "ipsec_establish_option": "IPSEC_EST_OPTION_NONE" }, "configurations": [ { "body": "string", "format": "string" } ] } }, "GetSiteDetailsResponse": { "title": "GetSiteDetailsResponse", "type": "object", "properties": { "site": { "$ref": "#/components/schemas/SiteDetails" }, "total": { "type": "integer", "description": "Total count.", "format": "int64" } }, "example": { "site": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ {} ], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ { "primary_tunnel": {}, "secondary_tunnel": {} } ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" }, "total": 1 } }, "GetSiteListResponse": { "title": "GetSiteListResponse", "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/ListSiteDetails" }, "description": "List of sites in system." }, "total": { "type": "integer", "description": "Total count of sites in system.", "format": "int64" } }, "example": { "sites": [ { "site_name": "string", "description": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "site_uuid": "string", "updated_timestamp": "string", "jsec_deploy_status": "NO_STATUS", "cpe_devices": [ { "name": "string", "ipsec_profile_name": "string", "tunnel_interface": "string", "trust_zone": "string", "cpe_interfaces": [ { "ike_id": "string", "ip_address": "string", "tunnel_type": "TYPE_NA", "external_interface_name": "string", "tunnel_interface": "string", "site_config": { "body": "string", "format": "string" }, "tunnel_info": [ {} ], "ip_address_type": "string", "name": "string" } ], "psk": "string", "configured_unit_number": "string", "untrust_zone": "string", "unit_number": "string", "tunnel_routing_instance": "string", "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true, "cpe_config": { "body": "string", "format": "string" }, "mist_config": { "pre_shared_key": "string", "local_identity": "string", "primary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "secondary": { "address": "string", "remote_identity": "string", "probe_source_ip": "string", "local_identity": "string" }, "ike_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "ipsec_proposal": { "authentication_method": "string", "dh_group": "string", "encryption_algorithm": "string", "protocol": "string", "pfs_group": "string", "lifetime_seconds": "string" }, "tunnel_pair": [ {} ] } } ], "max_users": "string", "deploy": true, "address_grp_name": "string", "address_grp_uuid": "string" } ], "total": 1 } }, "GetTunnelResponse": { "title": "GetTunnelResponse", "type": "object", "properties": { "tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelDetail" }, { "example": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } ] } }, "example": { "tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } }, "ListSiteDetails": { "title": "ListSiteDetails", "type": "object", "properties": { "site_name": { "type": "string", "description": "Name of the site." }, "description": { "type": "string", "description": "Site description." }, "primary_tenant_pop_id": { "type": "string", "description": "ID of the primary service location(tenant POP)." }, "secondary_tenant_pop_id": { "type": "string", "description": "ID of the secondary service location(tenant POP)." }, "private_nets": { "type": "array", "items": { "type": "string" }, "description": "List of private networks addresses in the site." }, "zip_code": { "type": "string", "description": "Zip code of the site." }, "country": { "type": "string", "description": "Country of the site." }, "site_uuid": { "type": "string", "description": "ID of the site in the system." }, "updated_timestamp": { "type": "string", "description": "Last updated time of the site." }, "jsec_deploy_status": { "$ref": "#/components/schemas/fapiprotoStatus" }, "cpe_devices": { "type": "array", "items": { "$ref": "#/components/schemas/CPEList" }, "description": "CPE devices under the site." }, "max_users": { "type": "string", "description": "Max number of users in site." }, "deploy": { "type": "boolean", "description": "This is true if site was deployed on creation." }, "address_grp_name": { "type": "string", "description": "Name of address group if used for the site." }, "address_grp_uuid": { "type": "string", "description": "ID of address group if used for the site." } } }, "ListTunnelsResponse": { "title": "ListTunnelsResponse", "type": "object", "properties": { "tunnels": { "type": "array", "items": { "$ref": "#/components/schemas/TunnelDetail" }, "description": "List of tunnel details." }, "total": { "type": "string", "description": "Total count of tunnels in the system." } }, "example": { "tunnels": [ { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } ], "total": "string" } }, "PagingSpec1": { "title": "PagingSpec1", "type": "object", "properties": { "size": { "type": "string", "description": "Optional: Max number of entries to fetch. Sets this limit as 100 by default if left blank." }, "from": { "type": "string", "description": "Optional: Starting offset of entries to fetch. Starts from 0 if left blank." } }, "example": { "size": "string", "from": "string" } }, "Site": { "title": "Site", "type": "object", "properties": { "site_name": { "type": "string", "description": "Mandatory: Name of the site." }, "description": { "type": "string", "description": "Optional: Site description." }, "site_type": { "type": "string", "description": "Optional: Type of site. eg: vSRX." }, "primary_tenant_pop_id": { "type": "string", "description": "Mandatory: ID to use for the primary tenant POP(service location). Information on present tenant POPs can be seen using GET /api/v2/tenant-pops." }, "secondary_tenant_pop_id": { "type": "string", "description": "Mandatory: ID of the secondary service location. Information on present tenant POPs can be seen using GET /api/v2/tenant-pops." }, "private_nets": { "type": "array", "items": { "type": "string" }, "description": "Mandatory: Denotes the list of IP address ranges at the site that are protected by Juniper Secure Edge." }, "zip_code": { "type": "string", "description": "Optional: Zip code of the site." }, "country": { "type": "string", "description": "Optional: Country of the site." }, "address": { "type": "string", "description": "Optional: Physical address of the site." }, "cpe_devices": { "type": "array", "items": { "$ref": "#/components/schemas/CPEDevice" }, "description": "Mandatory: Information on the customer premise devices." }, "max_users": { "type": "string", "description": "Mandatory: Max number of users who can use the network at the site." } }, "example": { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } }, "SiteDetails": { "title": "SiteDetails", "type": "object", "properties": { "site_name": { "type": "string", "description": "Name of the site." }, "description": { "type": "string", "description": "Site description." }, "site_type": { "type": "string", "description": "Type of site. eg: vSRX." }, "primary_tenant_pop_id": { "type": "string", "description": "ID of the primary service location." }, "secondary_tenant_pop_id": { "type": "string", "description": "ID of the secondary service location." }, "private_nets": { "type": "array", "items": { "type": "string" }, "description": "List of private networks addresses in the site." }, "zip_code": { "type": "string", "description": "Zip code of the site." }, "country": { "type": "string", "description": "Country of the site." }, "address": { "type": "string", "description": "Physical address of the site." }, "site_uuid": { "type": "string", "description": "ID of the site in the system." }, "updated_timestamp": { "type": "string", "description": "Last updated time of the site." }, "jsec_deploy_status": { "$ref": "#/components/schemas/fapiprotoStatus" }, "cpe_devices": { "type": "array", "items": { "$ref": "#/components/schemas/CPEList" }, "description": "CPE devices under the site." }, "max_users": { "type": "string", "description": "Max number of users in site." }, "deploy": { "type": "boolean", "description": "This is true if site was deployed on creation." }, "address_grp_name": { "type": "string", "description": "Name of address group if used for the site." }, "address_grp_uuid": { "type": "string", "description": "ID of address group if used for the site." } } }, "TunnelCountResponse": { "title": "TunnelCountResponse", "type": "object", "properties": { "not_monitored_count": { "type": "string", "description": "The number of tunnels that are currently unmonitored. A tunnel is unmonitored upon creation and until it goes to either an up or down state." }, "up_count": { "type": "string", "description": "The number of tunnels that are currently up. A tunnel is up when it is capable of passing traffic through it." }, "down_count": { "type": "string", "description": "The number of tunnels that are currently down. A tunnel is down when it is incapable of passing traffic through it." }, "total_count": { "type": "string", "description": "The total number of tunnels under the tenant." } }, "example": { "not_monitored_count": "string", "up_count": "string", "down_count": "string", "total_count": "string" } }, "TunnelDetail": { "title": "TunnelDetail", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the tunnel." }, "op_status": { "allOf": [ { "$ref": "#/components/schemas/fapiprotoTunnelStatus" }, { "example": "TS_NONE" } ] }, "site_ip": { "type": "string", "description": "IP address of endpoint 1 (site)." }, "service_ip": { "type": "string", "description": "IP address of endpoint 2 (service instance)." }, "site_name": { "type": "string", "description": "Name of the site associated with the tunnel." }, "service_location": { "type": "string", "description": "Location of service instance(Tenant POP is the same as a service location)." }, "tunnel_type": { "allOf": [ { "$ref": "#/components/schemas/Typeoftunnel" }, { "example": "TYPE_NA" } ] }, "is_primary": { "type": "boolean", "description": "True if this tunnel is on the primary service location." }, "config_message": { "type": "string", "description": "Tunnel configuration message." }, "config_status": { "$ref": "#/components/schemas/fapiprotoStatus" }, "partner_tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelPartnerInfo" }, { "example": { "name": "string" } } ] }, "active": { "type": "string", "description": "True if the tunnel is activated." }, "id": { "type": "string", "description": "ID of the tunnel." }, "probe_source_ip": { "type": "string", "description": "This is the source IP address assigned to a tunnel created in the presence of an external probe." }, "num_users": { "type": "string", "description": "Number of users in the tunnel." }, "service_location_uuid": { "type": "string", "description": "ID of the associated service location." }, "out_of_service": { "type": "boolean", "description": "This is true if the tunnel is out of service." }, "ike_id": { "type": "string", "description": "Associated IKE(Internet key exchange) Id of tunnel." }, "cpe_name": { "type": "string", "description": "Name of associated CPE." }, "cpe_interface_name": { "type": "string", "description": "Name of associated CPE interface." }, "tunnel_interface": { "type": "string", "description": "Interface of the tunnel." } }, "example": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } }, "TunnelInfo": { "title": "TunnelInfo", "type": "object", "properties": { "primary_tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelDetail" }, { "example": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } ] }, "secondary_tunnel": { "allOf": [ { "$ref": "#/components/schemas/TunnelDetail" }, { "example": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } ] } }, "example": { "primary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" }, "secondary_tunnel": { "name": "string", "op_status": "TS_NONE", "site_ip": "string", "service_ip": "string", "site_name": "string", "service_location": "string", "tunnel_type": "TYPE_NA", "is_primary": true, "config_message": "string", "config_status": "NO_STATUS", "partner_tunnel": { "name": "string" }, "active": "string", "id": "string", "probe_source_ip": "string", "num_users": "string", "service_location_uuid": "string", "out_of_service": true, "ike_id": "string", "cpe_name": "string", "cpe_interface_name": "string", "tunnel_interface": "string" } } }, "TunnelPartnerInfo": { "title": "TunnelPartnerInfo", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the partner tunnel." } }, "example": { "name": "string" } }, "ValidateSiteParamsRequest": { "title": "ValidateSiteParamsRequest", "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/Site" }, "description": "Mandatory: List of sites to validate." } }, "example": { "sites": [ { "site_name": "string", "description": "string", "site_type": "string", "primary_tenant_pop_id": "string", "secondary_tenant_pop_id": "string", "private_nets": [ "string" ], "zip_code": "string", "country": "string", "address": "string", "cpe_devices": [ { "name": "string", "psk": "string", "configured_unit_number": "string", "trust_zone": "string", "untrust_zone": "string", "tunnel_routing_instance": "string", "ipsec_profile_name": "string", "cpe_interfaces": [ { "ip_address": "string", "ike_id": "string", "external_interface_name": "string", "tunnel_type": "TYPE_NA", "tunnel_interface": "string", "ip_address_type": "string", "name": "string" } ], "cpe_type": "string", "use_site_secondary": true, "skip_tunnel_cfg": true } ], "max_users": "string" } ] } }, "ValidateSiteParamsResponse": { "title": "ValidateSiteParamsResponse", "type": "object", "properties": { "response": { "type": "string" } }, "example": { "response": "string" } }, "googlerpcStatus": { "title": "googlerpcStatus", "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny1" }, "description": "" } }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } }, "protobufAny1": { "title": "protobufAny1", "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {}, "example": { "@type": "string" } }, "DeploySiteRequest": { "title": "DeploySiteRequest", "type": "object", "properties": { "undeploy": { "type": "boolean", "description": "Optional: To undeploy the site." } }, "example": { "undeploy": true } }, "runtimeError1": { "title": "runtimeError1", "required": [ "message" ], "type": "object", "properties": { "code": { "type": "integer", "description": "Error code", "format": "int32" }, "message": { "type": "string", "description": "Error message" }, "details": { "type": "array", "items": { "type": "object" }, "description": "Error details" } }, "example": { "code": 1, "message": "string", "details": [ { "example": "string" } ] } }, "CreateIpsecProfileProfile": { "title": "CreateIpsecProfileProfile", "type": "object", "properties": { "profile_name": { "type": "string", "description": "Important: Name of the profile." }, "description": { "type": "string", "description": "Description of the profile." }, "ike_auth_method": { "$ref": "#/components/schemas/fapiprotoIkeAuthMethod" }, "ike_dh_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ike_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeAuthAlgorithm" }, "ike_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ike_lifetime": { "type": "integer", "description": "Important: Lifetime in seconds for the IPsec proposal.", "format": "int64" }, "ipsec_protocol": { "$ref": "#/components/schemas/fapiprotoIpsecProtocol" }, "ipsec_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIpsecAuthAlgorithm" }, "ipsec_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ipsec_lifetime": { "type": "integer", "description": "Important: Lifetime for Ipsec proposal.", "format": "int64" }, "ike_mode": { "$ref": "#/components/schemas/fapiprotoIkeMode" }, "ike_version": { "type": "string", "description": "Version for Ike gateway." }, "ike_dpd_enable": { "type": "boolean", "description": "To require DPD for Ike gateway to detect if a peer is dead or not." }, "ike_dpd_option": { "$ref": "#/components/schemas/fapiprotoIkeDpdOption" }, "ike_dpd_interval": { "type": "integer", "description": "Deprecated: Interval for Ike gateway.", "format": "int64" }, "ike_dpd_threshold": { "type": "integer", "description": "Deprecated: Threshold for Ike gateway.", "format": "int64" }, "ipsec_pfs_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ipsec_establish_option": { "allOf": [ { "$ref": "#/components/schemas/establishoption" }, { "example": "IPSEC_EST_OPTION_NONE" } ] } } }, "GetIpsecProfileResponseProfile": { "title": "GetIpsecProfileResponseProfile", "type": "object", "properties": { "profile_name": { "type": "string", "description": "Important: Name of the profile." }, "description": { "type": "string", "description": "Description of the profile." }, "ike_auth_method": { "$ref": "#/components/schemas/fapiprotoIkeAuthMethod" }, "ike_dh_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ike_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeAuthAlgorithm" }, "ike_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ike_lifetime": { "type": "integer", "description": "Important: Lifetime in seconds for the IPsec proposal.", "format": "int64" }, "ipsec_protocol": { "$ref": "#/components/schemas/fapiprotoIpsecProtocol" }, "ipsec_auth_algorithm": { "$ref": "#/components/schemas/fapiprotoIpsecAuthAlgorithm" }, "ipsec_encrypt_algorithm": { "$ref": "#/components/schemas/fapiprotoIkeEncryptAlgorithm" }, "ipsec_lifetime": { "type": "integer", "description": "Important: Lifetime for Ipsec proposal.", "format": "int64" }, "ike_mode": { "$ref": "#/components/schemas/fapiprotoIkeMode" }, "ike_version": { "type": "string", "description": "Version for Ike gateway." }, "ike_dpd_enable": { "type": "boolean", "description": "To require DPD for Ike gateway to detect if a peer is dead or not." }, "ike_dpd_option": { "$ref": "#/components/schemas/fapiprotoIkeDpdOption" }, "ike_dpd_interval": { "type": "integer", "description": "Deprecated: Interval for Ike gateway.", "format": "int64" }, "ike_dpd_threshold": { "type": "integer", "description": "Deprecated: Threshold for Ike gateway.", "format": "int64" }, "ipsec_pfs_group": { "$ref": "#/components/schemas/fapiprotoIkeDhGroup" }, "ipsec_establish_option": { "allOf": [ { "$ref": "#/components/schemas/establishoption" }, { "example": "IPSEC_EST_OPTION_NONE" } ] } } }, "GetTenantPopListResponse1": { "title": "GetTenantPopListResponse1", "type": "object", "properties": { "tenant_pops": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPopListObject" }, "description": "List of service locations in the system." }, "total": { "type": "integer", "description": "This is the number of service location entries present in the response.", "format": "int64" } }, "example": { "tenant_pops": [ { "tenant_pop": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } } ], "total": 1 } }, "PagingSpec2": { "title": "PagingSpec2", "type": "object", "properties": { "size": { "type": "string", "description": "This field is optional. This is to limit the number of tenant POPs(service locations) returned. A user can set the parameter spec.size as the limit. In the absence of this field, all requested information will be shown." }, "from": { "type": "string", "description": "This field is optional. To set an offset, the user can set this parameter to contain the offset." } }, "example": { "size": "string", "from": "string" } }, "TenantPop": { "title": "TenantPop", "type": "object", "properties": { "tenant_pop_id": { "type": "string", "description": "Important: The ID of the service location(Tenant POP). This can be used as input in many Site Management APIs." }, "pop_name": { "type": "string", "description": "The name of pop where service location is present." }, "pop_region": { "type": "string", "description": "The region where service location is present. This is same as pop_city." }, "pop_city": { "type": "string", "description": "Important: The city where service location is present." }, "num_users": { "type": "string", "description": "Important: The maximum number of users whose traffic can be under this service location." }, "status": { "type": "string", "description": "Important: Shows whether the creation of the service location is successful, failed or in progress." }, "pop_id": { "type": "string", "description": "This is the ID of the pop where the service location is present." }, "active_capacity": { "type": "integer", "description": "How much percentage of the service location is active and can pass traffic through it.", "format": "int32" }, "availability_zone": { "type": "string", "description": "This is the availability zone hosting the service location." }, "latitude": { "type": "string", "description": "Latitude of service location." }, "longitude": { "type": "string", "description": "Longitude of service location." }, "country": { "type": "string", "description": "Country of service location." }, "continent": { "type": "string", "description": "Continent of the service location." } }, "example": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } }, "TenantPopListObject": { "title": "TenantPopListObject", "type": "object", "properties": { "tenant_pop": { "allOf": [ { "$ref": "#/components/schemas/TenantPop" }, { "example": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } } ] } }, "example": { "tenant_pop": { "tenant_pop_id": "string", "pop_name": "string", "pop_region": "string", "pop_city": "string", "num_users": "string", "status": "string", "pop_id": "string", "active_capacity": 1, "availability_zone": "string", "latitude": "string", "longitude": "string", "country": "string", "continent": "string" } } }, "rpcStatus": { "title": "rpcStatus", "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny1" }, "description": "" } }, "example": { "code": 1, "message": "string", "details": [ { "@type": "string" } ] } }, "PacFilesResponse": { "title": "PacFilesResponse", "type": "object", "properties": { "pac_files": { "type": "array", "items": { "$ref": "#/components/schemas/PACFileInfo" }, "description": "Information on the pac files." } }, "example": { "pac_files": [ { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } ] } }, "PACFileInfo": { "title": "PACFileInfo", "type": "object", "properties": { "url": { "type": "string" }, "body": { "type": "string", "description": "Contents of the pac file." }, "description": { "type": "string", "description": "Description of the pac file." }, "name": { "type": "string" }, "is_generated": { "type": "boolean", "description": "Is this PAC file generated and not a custom file." }, "created_timestamp": { "type": "string", "description": "Creation time of the PAC file. This is in unix timestamp format." } }, "example": { "url": "string", "body": "string", "description": "string", "name": "string", "is_generated": true, "created_timestamp": "string" } }, "Device": { "title": "Device", "type": "object", "properties": { "uuid": { "type": "string", "description": "uuid is the unique identifier of the device." }, "name": { "type": "string", "description": "Name is the user-assigned name of the device." }, "system_info": { "allOf": [ { "$ref": "#/components/schemas/SystemInfoType" }, { "example": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" } } ] }, "management_state": { "type": "string", "description": "ManagementState indicates the current management status of the device.\nPossible values:\n - DISCOVERY_NOT_INITIATED: Discovery process has not started.\n - ZTP_NOT_INITIATED: Zero Touch Provisioning has not started.\n - DISCOVERY_FAILED: Device discovery failed.\n - DEVICE_DETECTED: Device has been detected.\n - DISCOVERY_IN_PROGRESS: Discovery is currently in progress.\n - MANAGED: Device is managed by the system.\n - UNMANAGED: Device is not managed by the system.\n - MAINTENANCE: Device is in maintenance mode.\n - SALVAGE: Device is in salvage state.\n - SYNC_PENDING: Device synchronization is pending.\n - MISCONFIGURED: Device is misconfigured." }, "login_connection_state": { "type": "string", "description": "LoginConnectionState indicates the current connection status to the device.\nPossible values:\n - UP: Connection to the device is established.\n - DOWN: Connection to the device is not established." }, "combined_state": { "type": "string", "description": "CombinedState represents the overall operational state derived from management and connection states." }, "device_sync_status": { "type": "string", "description": "DeviceSyncStatus indicates the synchronization status between the device and the system." }, "inventory_sync_info": { "allOf": [ { "$ref": "#/components/schemas/InventorySyncInfo" }, { "example": { "overall_sync_status": "string" } } ] }, "device_config_state": { "type": "string", "description": "DeviceConfigState describes whether the device contains out of band changes." } }, "example": { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string" } }, "DiscoveryProfile": { "title": "DiscoveryProfile", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the discovery profile", "readOnly": true }, "name": { "type": "string", "description": "Name of the discovery profile" }, "discovery_type": { "$ref": "#/components/schemas/apiDiscoveryType" }, "ip_address": { "type": "string", "description": "IP address used for device discovery. Present when discovery_type is IP_ADDRESS or IP_SUBNET." }, "ssh_port": { "type": "integer", "description": "SSH port used for device discovery (1-65535)", "format": "int32" }, "username": { "type": "string", "description": "Username used for device discovery authentication" }, "use_ping": { "type": "boolean", "description": "Whether ping is used during device discovery" }, "enable_proxy": { "type": "boolean", "description": "Whether proxy server is enabled for device discovery (true or false)" }, "hostname": { "type": "string", "description": "Hostname used for device discovery. Present when discovery_type is HOSTNAME." }, "subnet_mask": { "type": "integer", "description": "Subnet mask used for device discovery. Present when discovery_type is IP_SUBNET.", "format": "int32" }, "start_address": { "type": "string", "description": "Start IP address for range-based discovery. Present when discovery_type is IP_RANGE." }, "end_address": { "type": "string", "description": "End IP address for range-based discovery. Present when discovery_type is IP_RANGE." }, "password": { "type": "string", "description": "Password used for device discovery authentication" }, "routing_instance": { "type": "string", "description": "Routing instance used for device discovery" } }, "description": "Device discovery profile details including discovery type, address, and scheduling information", "example": { "uuid": "string", "name": "string", "discovery_type": "IP_ADDRESS", "ip_address": "string", "ssh_port": 1, "username": "string", "use_ping": true, "enable_proxy": true, "hostname": "string", "subnet_mask": 1, "start_address": "string", "end_address": "string", "password": "string", "routing_instance": "string" } }, "DiscoveryProfileInput": { "title": "DiscoveryProfileInput", "required": [ "name", "discovery_type", "username", "password" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the discovery profile" }, "discovery_type": { "$ref": "#/components/schemas/apiDiscoveryType" }, "ip_address": { "type": "string", "description": "IP address used for device discovery. Required when discovery_type is IP_ADDRESS or IP_SUBNET." }, "ssh_port": { "type": "integer", "description": "SSH port used for device discovery (1-65535)", "format": "int32" }, "username": { "type": "string", "description": "Username used for device discovery authentication" }, "use_ping": { "type": "boolean", "description": "Whether ping is used during device discovery" }, "enable_proxy": { "type": "boolean", "description": "Whether proxy server is enabled for device discovery (true or false)" }, "hostname": { "type": "string", "description": "Hostname used for device discovery. Required when discovery_type is HOSTNAME." }, "subnet_mask": { "type": "integer", "description": "Subnet mask used for device discovery. Required when discovery_type is IP_SUBNET.", "format": "int32" }, "start_address": { "type": "string", "description": "Start IP address for range-based discovery. Required when discovery_type is IP_RANGE." }, "end_address": { "type": "string", "description": "End IP address for range-based discovery. Required when discovery_type is IP_RANGE." }, "password": { "type": "string", "description": "Password used for device discovery authentication" }, "routing_instance": { "type": "string", "description": "Routing instance used for device discovery" } }, "description": "Writable fields for creating or updating a device discovery profile", "example": { "name": "string", "discovery_type": "IP_ADDRESS", "ip_address": "string", "ssh_port": 1, "username": "string", "use_ping": true, "enable_proxy": true, "hostname": "string", "subnet_mask": 1, "start_address": "string", "end_address": "string", "password": "string", "routing_instance": "string" } }, "apiDiscoveryType": { "title": "apiDiscoveryType", "enum": [ "IP_ADDRESS", "IP_SUBNET", "IP_RANGE", "HOSTNAME" ], "type": "string", "description": "DiscoveryType defines the method used for device discovery.\n\n - IP_ADDRESS: Discover a single device by IP address\n - IP_SUBNET: Discover devices on a subnet\n - IP_RANGE: Discover devices in an IP range\n - HOSTNAME: Discover a device by hostname", "example": "IP_ADDRESS" }, "GetDeviceResponse": { "title": "GetDeviceResponse", "type": "object", "properties": { "uuid": { "type": "string", "description": "uuid is the unique identifier of the device.", "readOnly": true }, "name": { "type": "string", "description": "Name is the user-assigned name of the device." }, "system_info": { "allOf": [ { "$ref": "#/components/schemas/SystemInfoType" }, { "example": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" } } ] }, "management_state": { "type": "string", "description": "ManagementState indicates the current management status of the device.\nPossible values:\n - DISCOVERY_NOT_INITIATED: Discovery process has not started.\n - ZTP_NOT_INITIATED: Zero Touch Provisioning has not started.\n - DISCOVERY_FAILED: Device discovery failed.\n - DEVICE_DETECTED: Device has been detected.\n - DISCOVERY_IN_PROGRESS: Discovery is currently in progress.\n - MANAGED: Device is managed by the system.\n - UNMANAGED: Device is not managed by the system.\n - MAINTENANCE: Device is in maintenance mode.\n - SALVAGE: Device is in salvage state.\n - SYNC_PENDING: Device synchronization is pending.\n - MISCONFIGURED: Device is misconfigured." }, "login_connection_state": { "type": "string", "description": "LoginConnectionState indicates the current connection status to the device.\nPossible values:\n - UP: Connection to the device is established.\n - DOWN: Connection to the device is not established." }, "combined_state": { "type": "string", "description": "CombinedState represents the overall operational state derived from management and connection states." }, "device_sync_status": { "type": "string", "description": "DeviceSyncStatus indicates the synchronization status between the device and the system." }, "inventory_sync_info": { "allOf": [ { "$ref": "#/components/schemas/InventorySyncInfo" }, { "example": { "overall_sync_status": "string" } } ] }, "device_config_state": { "type": "string", "description": "DeviceConfigState describes whether the device contains out of band changes." }, "sd_onboarding_completed": { "type": "string", "description": "Indicates whether Security Director specific onboarding steps have completed for the device. \"true\" means SD onboarding finished successfully; \"false\" means it has not. An empty value means onboarding has not yet run or its outcome is not yet known. This is a read-only, server-computed field.", "readOnly": true }, "certificate_ready": { "type": "string", "description": "Indicates whether the Security Director certificate-deployment job succeeded for the device. \"true\" means the SD certificates were deployed successfully; \"false\" means the deployment failed. An empty value means certificate deployment has not yet run or its outcome is not yet known. This is a read-only, server-computed field.", "readOnly": true }, "firewall_ready": { "type": "string", "description": "Indicates whether the device is ready for firewall-policy processing. \"true\" means the device is ready (firewall-policy import/publish completed or nothing is pending); \"false\" means the most recent firewall-policy import/publish failed. An empty value means a firewall-policy import/publish is still pending. This is a read-only, server-computed field.", "readOnly": true }, "nat_ready": { "type": "string", "description": "Indicates whether the device is ready for NAT-policy processing. \"true\" means the device is ready (NAT-policy import/publish completed or nothing is pending); \"false\" means the most recent NAT-policy import/publish failed. An empty value means a NAT-policy import/publish is still pending. This is a read-only, server-computed field.", "readOnly": true }, "security_log_ready": { "type": "string", "description": "Indicates whether security logging is configured and ready on the device. \"true\" means the configure-security-logs job completed successfully; \"false\" means security logging was skipped or its configuration failed. An empty value means security-log configuration has not yet run or its outcome is not yet known. This is a read-only, server-computed field.", "readOnly": true } }, "description": "GetDeviceResponse represents the response containing a single device's information.\nThis message is returned when a device is successfully retrieved.", "example": { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string", "sd_onboarding_completed": "string", "certificate_ready": "string", "firewall_ready": "string", "nat_ready": "string", "security_log_ready": "string" } }, "InventorySyncInfo": { "title": "InventorySyncInfo", "type": "object", "properties": { "overall_sync_status": { "type": "string", "description": "OverallSyncStatus is the overall synchronization status.\nPossible values:\n - IN_SYNC: All resources are synchronized.\n - OUT_OF_SYNC: One or more resources are not synchronized.\n - SYNC_IN_PROGRESS: Synchronization is currently in progress.\n - UNKNOWN: Synchronization status is unknown." } }, "example": { "overall_sync_status": "string" } }, "License": { "title": "License", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the license", "readOnly": true }, "name": { "type": "string", "description": "Name of the license" }, "version": { "type": "string", "description": "License version" }, "state": { "type": "string", "description": "Current state of the license" }, "validity_type": { "type": "string", "description": "Validity type of the license (e.g., permanent, date-based)" }, "start_date": { "type": "string", "description": "License start date" }, "end_date": { "type": "string", "description": "License end date" } }, "description": "License represents a license resource installed on a device.", "example": { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } }, "ListDeviceDiscoveryProfilesResponse": { "title": "ListDeviceDiscoveryProfilesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoveryProfile" }, "description": "Items contains the complete information of the requested discovery profiles." }, "count": { "type": "integer", "description": "Total number of discovery profiles available", "format": "int32" } }, "description": "Response containing list of device discovery profiles and total count", "example": { "items": [ { "uuid": "string", "name": "string", "discovery_type": "IP_ADDRESS", "ip_address": "string", "ssh_port": 1, "username": "string", "use_ping": true, "enable_proxy": true, "hostname": "string", "subnet_mask": 1, "start_address": "string", "end_address": "string", "password": "string", "routing_instance": "string" } ], "count": 1 } }, "ListDevicesResponse": { "title": "ListDevicesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Device" }, "description": "Items contains the complete information of the requested devices." }, "count": { "type": "integer", "description": "Count represents the total number of devices that match the request criteria.\nThis count may be larger than the number of items in Devices if pagination is applied.\nThis field will be serialized as \"count\" in JSON format.", "format": "int32" } }, "description": "ListDevicesResponse represents the response containing a list of devices and metadata.\nThis message provides both the device data and pagination information.", "example": { "items": [ { "uuid": "string", "name": "string", "system_info": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" }, "management_state": "string", "login_connection_state": "string", "combined_state": "string", "device_sync_status": "string", "inventory_sync_info": { "overall_sync_status": "string" }, "device_config_state": "string" } ], "count": 1 } }, "ListLicensesResponse": { "title": "ListLicensesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/License" }, "description": "List of licenses" }, "count": { "type": "integer", "description": "Total number of licenses", "format": "int32" } }, "description": "Response containing a paginated list of licenses for a device", "example": { "items": [ { "uuid": "string", "name": "string", "version": "string", "state": "string", "validity_type": "string", "start_date": "string", "end_date": "string" } ], "count": 1 } }, "SystemInfoType": { "title": "SystemInfoType", "type": "object", "properties": { "host_name": { "type": "string", "description": "HostName is the system's hostname as reported by the device." }, "os_name": { "type": "string", "description": "OsName is the OS name (like junos, ios)." }, "os_version": { "type": "string", "description": "OsVersion is the OS version." }, "hardware_model": { "type": "string", "description": "HardwareModel is the hardware model." }, "serial_number": { "type": "string", "description": "SerialNumber is the serial number." }, "cluster_type": { "type": "string", "description": "ClusterType is the type of clustering (if any)." } }, "example": { "host_name": "string", "os_name": "string", "os_version": "string", "hardware_model": "string", "serial_number": "string", "cluster_type": "string" } }, "CreateDeviceGroupRequest": { "title": "CreateDeviceGroupRequest", "required": [ "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the device group.", "readOnly": true }, "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "description": "CreateDeviceGroupRequest represents a request to create a new device group.\nIt contains the device group details to be created.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "CreateDeviceGroupResponse": { "title": "CreateDeviceGroupResponse", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the device group.", "readOnly": true }, "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "description": "CreateDeviceGroupResponse represents the response after creating a device group.\nIt contains the UUID of the created device group and a result message.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "DeleteDeviceGroupsResponse": { "title": "DeleteDeviceGroupsResponse", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of deleted device group." } }, "description": "DeleteDeviceGroupsResponse represents the response after deleting device group.\nIt contains the status and a message about the delete operation.", "example": { "uuid": "string" } }, "DeviceGroup": { "title": "DeviceGroup", "required": [ "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the device group.", "readOnly": true }, "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "DeviceReference": { "title": "DeviceReference", "required": [ "device_uuid" ], "type": "object", "properties": { "device_name": { "type": "string", "description": "The name of the device. This field is optional; when creating a device group, device_name does not need to be provided in the payload.", "readOnly": true }, "device_uuid": { "type": "string", "description": "The unique identifier of the device." }, "device_status": { "type": "string", "description": "The status of the device. This field is optional; when creating a device group, device_status does not need to be provided in the payload.\nPossible values:\n - DISCOVERY_NOT_INITIATED: Discovery process has not started.\n - ZTP_NOT_INITIATED: Zero Touch Provisioning has not started.\n - DISCOVERY_FAILED: Device discovery failed.\n - DEVICE_DETECTED: Device has been detected.\n - DISCOVERY_IN_PROGRESS: Discovery is currently in progress.\n - MANAGED: Device is managed by the system.\n - UNMANAGED: Device is not managed by the system.\n - MAINTENANCE: Device is in maintenance mode.\n - SALVAGE: Device is in salvage state.\n - SYNC_PENDING: Device synchronization is pending.\n - MISCONFIGURED: Device is misconfigured.", "readOnly": true } }, "description": "DeviceReference represents a reference to a device within a device group.\nIt contains minimal identifying information about the device.", "example": { "device_name": "string", "device_uuid": "string", "device_status": "string" } }, "GetDeviceGroupResponse": { "title": "GetDeviceGroupResponse", "required": [ "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the device group.", "readOnly": true }, "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "description": "GetDeviceGroupResponse represents the response containing a single device group's information.\nIt includes the essential details of the requested device group.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "ListDeviceGroupsResponse": { "title": "ListDeviceGroupsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceGroup" }, "description": "Items represents list of external-facing device group model" }, "count": { "type": "integer", "description": "The total count of device groups matching the query.", "format": "int32" } }, "description": "ListDeviceGroupsResponse represents the response containing a list of device groups.\nIt also includes metadata such as the total count of device groups matching the query.", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } ], "count": 1 } }, "UpdateDeviceGroupResponse": { "title": "UpdateDeviceGroupResponse", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the device group.", "readOnly": true }, "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "description": "UpdateDeviceGroupResponse represents the response after updating a device group.\nIt contains the UUID of the updated device group and a result message.", "example": { "uuid": "string", "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "UpdateDeviceGroupRequest": { "title": "UpdateDeviceGroupRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string", "description": "The name of the device group." }, "description": { "type": "string", "description": "The description of the device group." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceReference" }, "description": "List of devices associated with the device group." } }, "description": "UpdateDeviceGroupRequest represents a request to update an existing device group.\nIt contains the UUID of the device group and the updated device group information.", "example": { "name": "string", "description": "string", "devices": [ { "device_name": "string", "device_uuid": "string", "device_status": "string" } ] } }, "AssociationResult": { "title": "AssociationResult", "type": "object", "properties": { "template_id": { "type": "string", "description": "UUID of the configuration template" }, "device_uuid": { "type": "string", "description": "UUID of the device" }, "status": { "type": "string", "description": "Status of the association (success, failure)" }, "message": { "type": "string", "description": "Message describing the association result" } }, "description": "AssociationResult represents the result of a single device-template association.", "example": { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } }, "CSVTemplateDownloadResponse": { "title": "CSVTemplateDownloadResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the download operation (SUCCESS, FAILURE)" }, "signed_url": { "type": "string", "description": "Pre-signed URL for downloading the generated CSV file. Valid for a limited time." }, "error_message": { "type": "string", "description": "Error message if the download operation failed (empty on success)" }, "file_name": { "type": "string", "description": "Name of the generated CSV file" } }, "description": "CSVTemplateDownloadResponse represents the response for CSV template download.", "example": { "status": "string", "signed_url": "string", "error_message": "string", "file_name": "string" } }, "CSVTemplateUploadResponse": { "title": "CSVTemplateUploadResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the upload operation (SUCCESS, FAILURE, PARTIAL_SUCCESS)" }, "message": { "type": "string", "description": "Message describing the overall upload result" }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationResult" }, "description": "List of device-template association results" }, "template_name": { "type": "string", "description": "Name of the configuration template" }, "template_id": { "type": "string", "description": "UUID of the configuration template" }, "total_records": { "type": "integer", "description": "Total number of records processed from the CSV file", "format": "int32" }, "error_message": { "type": "string", "description": "Error message if the upload operation failed (empty on success)" } }, "description": "CSVTemplateUploadResponse represents the response for CSV template upload.", "example": { "status": "string", "message": "string", "associations": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ], "template_name": "string", "template_id": "string", "total_records": 1, "error_message": "string" } }, "ClusterRoutingInstance": { "title": "ClusterRoutingInstance", "type": "object", "properties": { "node0": { "type": "string", "description": "Routing instance name for cluster node 0" }, "node1": { "type": "string", "description": "Routing instance name for cluster node 1" } }, "description": "Routing instance configuration for l2 cluster nodes", "example": { "node0": "string", "node1": "string" } }, "ConfigTemplate": { "title": "ConfigTemplate", "required": [ "name", "template" ], "type": "object", "properties": { "name": { "pattern": "^[\\-_\\.\\w\\s]+$", "type": "string" }, "description": { "type": "string", "description": "The description of the configuration template." }, "format": { "type": "string", "description": "Format of the configuration template (e.g., CLI, XML)." }, "template": { "type": "string", "description": "The configuration template content in jinja syntax." } }, "example": { "name": "string", "description": "string", "format": "string", "template": "string" } }, "ConfigVersion": { "title": "ConfigVersion", "type": "object", "properties": { "version_number": { "type": "string", "description": "Version number of the archived configuration" }, "description": { "type": "string", "description": "Description of the configuration version" }, "archived_timestamp": { "type": "string", "description": "Timestamp when the configuration was archived" }, "revision": { "type": "string", "description": "Revision identifier of the configuration" } }, "description": "Details of an archived configuration version", "example": { "version_number": "string", "description": "string", "archived_timestamp": "string", "revision": "string" } }, "CreateWithViewdefRequest": { "title": "CreateWithViewdefRequest", "required": [ "config_template" ], "type": "object", "properties": { "config_template": { "allOf": [ { "$ref": "#/components/schemas/ConfigTemplate" }, { "example": { "name": "string", "description": "string", "format": "string", "template": "string" } } ] }, "viewdef": { "type": "string", "description": "viewdef for the config template (UI form definition for parameter input). Sample viewdef for banner template: {\"viewdef\":{\"version\":\"2.0\",\"path\":\"$\",\"viewdefs\":[{\"id\":\"entry\",\"type\":\"panel\",\"path\":\"configuration\",\"properties\":{\"size\":\"xlarge\"},\"readonly\":false,\"children\":[{\"path\":\".\",\"children\":[{\"path\":\"message\",\"label\":\"Login message\",\"type\":\"TEXT\",\"id\":\"message\",\"required\":false,\"scope\":\"entity\"}],\"fullPath\":\"configuration\",\"dataFullPath\":\"configuration\"}],\"fullPath\":\"configuration\",\"dataFullPath\":\"configuration\",\"uniqueId\":\"entry_0\"}],\"resources\":[]}}" }, "variablesdef": { "type": "string", "description": "variablesdef for the config template (JSON variable definitions and schemas). Sample variablesdef for banner template: [{\"name\":\"message\",\"description\":\"\",\"type\":\"string\",\"required\":true,\"mode\":\"global\"}]" } }, "description": "Request to create a new configuration template. The uuid field in config_template will be ignored as UUIDs are system-generated.", "example": { "config_template": { "name": "string", "description": "string", "format": "string", "template": "string" }, "viewdef": "string", "variablesdef": "string" } }, "CreateWithViewdefResponse": { "title": "CreateWithViewdefResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Operation status: SUCCESS or FAILURE" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the creation result" }, "template_id": { "type": "string", "description": "UUID of the newly created template (populated on SUCCESS)" } }, "description": "CreateWithViewdefResponse contains the result of creating a new configuration template.\nProvides the UUID and version of the newly created template.", "example": { "status": "string", "message": "string", "template_id": "string" } }, "DeleteTemplateMappingResponse": { "title": "DeleteTemplateMappingResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Operation status: SUCCESS or FAILURE" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the deletion result" }, "device_id": { "type": "string", "description": "UUID of the device or device-group whose mapping was deleted" }, "template_id": { "type": "string", "description": "UUID of the template whose mapping was deleted" }, "template_name": { "type": "string", "description": "Name of the template whose mapping was deleted" } }, "description": "DeleteTemplateMappingResponse contains the result of deleting a device mapping.", "example": { "status": "string", "message": "string", "device_id": "string", "template_id": "string", "template_name": "string" } }, "DeleteTemplateResponse": { "title": "DeleteTemplateResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Overall operation status: SUCCESS (all deleted), FAILURE (all failed), or PARTIAL_SUCCESS (some succeeded, some failed)" }, "message": { "type": "string", "description": "Descriptive message providing summary information about the deletion operation" }, "template_id": { "type": "string", "description": "UUID of the deleted template" }, "template_name": { "type": "string", "description": "Name of the deleted template" } }, "description": "DeleteTemplateResponse contains the result of deleted configuration template.\nProvides individual results for each template deletion attempt.", "example": { "status": "string", "message": "string", "template_id": "string", "template_name": "string" } }, "DeployTemplateResponse": { "title": "DeployTemplateResponse", "type": "object", "properties": { "deploy_id": { "type": "string", "description": "Unique job identifier for tracking the deployment operation. Use this with GetTemplateDeployStatus to check progress." }, "status": { "type": "string", "description": "Initial status of the deployment request: SUCCESS (deployment started) or FAILURE (deployment could not be initiated)" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the deployment initiation" }, "scheduled_deploy_id": { "type": "string", "description": "Job identifier for scheduled deployment (populated only if deployment was scheduled for future execution)" } }, "description": "DeployTemplateResponse contains the result of initiating a template deployment.\nProvides job identifiers for tracking the deployment progress and status.", "example": { "deploy_id": "string", "status": "string", "message": "string", "scheduled_deploy_id": "string" } }, "apiDeploymentObject": { "title": "apiDeploymentObject", "type": "object", "properties": { "params": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceParam" }, "description": "Array of device-specific parameter mappings. Each DeviceParam contains device type (DEVICE/DEVICE_GROUP), device ID, and payload with template variable values." }, "global_params": { "type": "object", "description": "Global parameters that apply to all devices in the deployment." } }, "description": "DeploymentObject contains deployment configuration for template operations.\nThis message defines device-specific parameters and global settings for deployment.", "example": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } }, "DeviceConfigInterface": { "title": "DeviceConfigInterface", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the interface." } }, "description": "An interface on a device.", "example": { "name": "string" } }, "DeviceConfigInterfaceAddress": { "title": "DeviceConfigInterfaceAddress", "type": "object", "properties": { "name": { "type": "string", "description": "IP address in CIDR notation (e.g. 10.0.0.1/24)." } }, "description": "An IP address assigned to an interface.", "example": { "name": "string" } }, "DeviceConfigRoutingInstance": { "title": "DeviceConfigRoutingInstance", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the routing instance." }, "instance_type": { "type": "string", "description": "Type of the routing instance." }, "interface": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigInterfaceAddress" }, "description": "List of interfaces associated with the routing." } }, "description": "A routing instance on a device.", "example": { "name": "string", "instance_type": "string", "interface": [ { "name": "string" } ] } }, "DeviceConfigSubInterface": { "title": "DeviceConfigSubInterface", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the sub-interface (e.g. ge-0/0/0.0)." }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigInterfaceAddress" }, "description": "IP address assigned to the sub-interface." } }, "description": "A sub-interface on a device interface.", "example": { "name": "string", "address": [ { "name": "string" } ] } }, "DeviceConfigZone": { "title": "DeviceConfigZone", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the configuration zone." } }, "description": "A configuration zone on a device.", "example": { "name": "string" } }, "DeviceDeploymentStatus": { "title": "DeviceDeploymentStatus", "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the device for this deployment result" }, "name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the deployment for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "message": { "type": "string", "description": "Descriptive message with deployment details or error information for this device" } }, "description": "DeviceDeploymentStatus contains the deployment status for a single device.\nIncludes the basic status information without the deployed configuration.", "example": { "id": "string", "name": "string", "status": "string", "message": "string" } }, "DeviceDiscoverDetail": { "title": "DeviceDiscoverDetail", "type": "object", "properties": { "resource": { "type": "string", "description": "Resource identifier (IP address or hostname) of the discovered device" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Status message describing the discovery result for this device" } }, "description": "Discovery result for a single device", "example": { "resource": "string", "status": "FAILURE", "message": "string" } }, "DeviceParam": { "title": "DeviceParam", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiDeviceType" }, "id": { "type": "string", "description": "Unique identifier (UUID) of the target device, device group, or cluster" }, "payload": { "type": "object", "description": "JSON object containing template variable values specific to this target. These values override global_params for this device. Sample payload for banner template: {\"message\":\"banner-message\"}" } }, "description": "DeviceParam specifies a target device/group and its template variable values for deployment.", "example": { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } }, "DevicePreviewStatus": { "title": "DevicePreviewStatus", "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the device for this preview result" }, "name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the preview for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "message": { "type": "string", "description": "Descriptive message with details or error information for this device's preview" } }, "description": "DevicePreviewStatus contains the preview status for a single device.\nIncludes the basic status information without the configuration diff.", "example": { "id": "string", "name": "string", "status": "string", "message": "string" } }, "DeviceRebootDetail": { "title": "DeviceRebootDetail", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the device" }, "name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Optional descriptive message about the device reboot status" } }, "description": "Reboot status information for a single device", "example": { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } }, "DeviceSyncStatus": { "title": "DeviceSyncStatus", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the device" }, "name": { "type": "string", "description": "Hostname of the device" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the sync operation status" } }, "description": "Sync status information for a single device", "example": { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } }, "apiDeviceType": { "title": "apiDeviceType", "enum": [ "DEVICE", "DEVICE_GROUP" ], "type": "string", "description": "DeviceType enum distinguishes between different target types for template operations.\nDetermines whether the template should be applied to a single device, device group, or cluster.\n\n - DEVICE: DEVICE - Single network device (e.g., router, switch, firewall)\n - DEVICE_GROUP: DEVICE_GROUP - Logical group of devices for bulk operations", "example": "DEVICE" }, "DeviceValidateStatus": { "title": "DeviceValidateStatus", "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the device for this validation result" }, "name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the validation for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "message": { "type": "string", "description": "Descriptive message with validation details or error information for this device" } }, "description": "DeviceValidateStatus contains the validation status for a single device.\nIncludes the basic status information without the validated configuration.", "example": { "id": "string", "name": "string", "status": "string", "message": "string" } }, "EditWithViewdefResponse": { "title": "EditWithViewdefResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Operation status: SUCCESS or FAILURE" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the update result" }, "template_id": { "type": "string", "description": "UUID of the updated template" }, "template_name": { "type": "string", "description": "Name of the updated template" } }, "description": "EditWithViewdefResponse contains the result of updating an existing configuration template.\nProvides the UUID and updated version number of the modified template.", "example": { "status": "string", "message": "string", "template_id": "string", "template_name": "string" } }, "GetBootstrapConfigInput": { "title": "GetBootstrapConfigInput", "type": "object", "properties": { "enable_proxy": { "type": "boolean", "description": "When true, enables proxy server (proxy_default) for device connectivity. When false, clears any existing proxy server configuration from the device." }, "routing_instance_configuration": { "$ref": "#/components/schemas/GetBootstrapConfigInputRoutingInstanceConfiguration" } }, "description": "GetBootstrapConfigInput contains the body fields for the GetBootstrapConfig operation.", "example": { "enable_proxy": true, "routing_instance_configuration": { "standalone": "string", "cluster": { "node0": "string", "node1": "string" } } } }, "GetBootstrapConfigResponse": { "title": "GetBootstrapConfigResponse", "type": "object", "properties": { "bootstrap_config": { "type": "string", "description": "Bootstrap CLI configurations for the device" } }, "description": "Response containing bootstrap configuration for the requested device", "example": { "bootstrap_config": "string" } }, "GetDeployResultByDeviceResponse": { "title": "GetDeployResultByDeviceResponse", "type": "object", "properties": { "template_id": { "type": "string", "description": "UUID of the template that was deployed" }, "template_name": { "type": "string", "description": "Name of the template that was deployed" }, "device_id": { "type": "string", "description": "UUID of the device for this deployment result" }, "device_name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the deployment for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "deployed_config": { "type": "string", "description": "The configuration that was deployed to this device (if deployment succeeded)" }, "message": { "type": "string", "description": "Descriptive message with deployment details or error information for this device" } }, "description": "GetDeployResultByDeviceResponse contains the deployment result for a specific device.\nReturns the device-specific deployment result including deployed configuration and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "deployed_config": "string", "message": "string" } }, "GetDeployStatusResponse": { "title": "GetDeployStatusResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Overall status of the deployment operation: SUCCESS, FAILURE, PARTIAL_SUCCESS, or IN_PROGRESS" }, "template_id": { "type": "string", "description": "UUID of the template that was deployed" }, "template_name": { "type": "string", "description": "Name of the template that was deployed" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the deployment results" }, "device_deploy_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDeploymentStatus" }, "description": "Array of deployment results, one per target device, containing deployment status and configuration" } }, "description": "GetDeployStatusResponse contains the deployment status and results for all target devices.\nIncludes the deployed configuration and status for each device.", "example": { "status": "string", "template_id": "string", "template_name": "string", "message": "string", "device_deploy_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ] } }, "GetDeviceConfigIdpSensorResponse": { "title": "GetDeviceConfigIdpSensorResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IdpSensorConfiguration" }, "description": "Array of IDP sensor configurations for the device." }, "count": { "type": "integer", "description": "Total number of IDP sensor configurations.", "format": "int32" } }, "description": "Response containing the IDP sensor configuration for a device.", "example": { "items": [ { "packet_log": { "host": { "ipaddr": "string", "port": "string" }, "source_address": "string", "threshold_logging_interval": "string", "max_sessions": { "percentage_value": "string" }, "total_memory": { "percentage_value": "string" } } } ], "count": 1 } }, "GetDeviceConfigInterfaceResponse": { "title": "GetDeviceConfigInterfaceResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigInterface" }, "description": "Array of interfaces for the device." }, "count": { "type": "integer", "description": "Total number of interfaces matching the request.", "format": "int32" } }, "description": "Response containing the interfaces for a device.", "example": { "items": [ { "name": "string" } ], "count": 1 } }, "GetDeviceConfigRIResponse": { "title": "GetDeviceConfigRIResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigRoutingInstance" }, "description": "Array of routing instances for the device." }, "count": { "type": "integer", "description": "Total number of routing instances matching the request.", "format": "int32" } }, "description": "Response containing the routing instances for a device.", "example": { "items": [ { "name": "string", "instance_type": "string", "interface": [ { "name": "string" } ] } ], "count": 1 } }, "GetDeviceConfigRevisionsResponse": { "title": "GetDeviceConfigRevisionsResponse", "type": "object", "properties": { "device_config_revision": { "type": "string", "description": "Unix timestamp (seconds) of the current configuration revision on the device." }, "last_sync_revision": { "type": "string", "description": "Unix timestamp (seconds) of the last successfully synced revision." } }, "description": "Response containing the configuration revision status for a device.", "example": { "device_config_revision": "string", "last_sync_revision": "string" } }, "GetDeviceConfigSubInterfaceResponse": { "title": "GetDeviceConfigSubInterfaceResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigSubInterface" }, "description": "Array of sub-interfaces for the device interface." }, "count": { "type": "integer", "description": "Total number of sub-interfaces matching the request.", "format": "int32" } }, "description": "Response containing the sub-interfaces for a device interface.", "example": { "items": [ { "name": "string", "address": [ { "name": "string" } ] } ], "count": 1 } }, "GetDeviceConfigZonesResponse": { "title": "GetDeviceConfigZonesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigZone" }, "description": "Array of configuration zones for the device." }, "count": { "type": "integer", "description": "Total number of configuration zones matching the request.", "format": "int32" } }, "description": "Response containing the configuration zones for a device.", "example": { "items": [ { "name": "string" } ], "count": 1 } }, "GetDiscoverDevicesStatusResponse": { "title": "GetDiscoverDevicesStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "device_discover_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDiscoverDetail" }, "description": "Array of per-device discovery results with resource identifier, status, and status message" } }, "description": "Response containing device discovery operation status and results", "example": { "status": "FAILURE", "device_discover_status": [ { "resource": "string", "status": "FAILURE", "message": "string" } ] } }, "GetMnhaSyncStatusResponse": { "title": "GetMnhaSyncStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "device_sync_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceSyncStatus" }, "description": "Array of device-specific MNHA sync results with status for each device" } }, "description": "Response containing MNHA sync operation status and device results", "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } }, "GetPreviewResultByDeviceResponse": { "title": "GetPreviewResultByDeviceResponse", "type": "object", "properties": { "template_id": { "type": "string", "description": "UUID of the template that was previewed" }, "template_name": { "type": "string", "description": "Name of the template that was previewed" }, "device_id": { "type": "string", "description": "UUID of the device for this preview result" }, "device_name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the preview for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "config_diff": { "type": "string", "description": "Generated configuration diff showing the changes that would be applied to the device." }, "message": { "type": "string", "description": "Descriptive message with details or error information for this device's preview" } }, "description": "GetPreviewResultByDeviceResponse contains the preview result for a specific device.\nReturns the device-specific preview result including configuration diff and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "config_diff": "string", "message": "string" } }, "GetPreviewStatusResponse": { "title": "GetPreviewStatusResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Overall status of the preview operation: SUCCESS, FAILURE, or IN_PROGRESS" }, "template_id": { "type": "string", "description": "UUID of the template that was previewed" }, "template_name": { "type": "string", "description": "Name of the template that was previewed" }, "device_preview_status": { "type": "array", "items": { "$ref": "#/components/schemas/DevicePreviewStatus" }, "description": "Array of preview results, one per target device, containing generated configuration diffs" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the preview results" } }, "description": "GetPreviewStatusResponse contains the configuration preview results for all target devices.\nIncludes the generated configuration diff for each device along with status information.", "example": { "status": "string", "template_id": "string", "template_name": "string", "device_preview_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } }, "GetRebootStatusResponse": { "title": "GetRebootStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "device_reboot_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceRebootDetail" }, "description": "Array of device-specific reboot results with status for each device" } }, "description": "Response containing reboot operation status and device results", "example": { "status": "FAILURE", "device_reboot_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } }, "GetRollbackConfigVersionStatusResponse": { "title": "GetRollbackConfigVersionStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the rollback operation status" }, "device_uuid": { "type": "string", "description": "UUID of the device the rollback was performed on" } }, "description": "Response containing configuration rollback operation status and details", "example": { "status": "FAILURE", "message": "string", "device_uuid": "string" } }, "GetSyncStatusResponse": { "title": "GetSyncStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "device_sync_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceSyncStatus" }, "description": "Array of device-specific sync results with status for each device" } }, "description": "Response containing sync operation status and device results", "example": { "status": "FAILURE", "device_sync_status": [ { "uuid": "string", "name": "string", "status": "FAILURE", "message": "string" } ] } }, "GetTemplateMappingResponse": { "title": "GetTemplateMappingResponse", "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateMapping" }, "description": "The device mapping containing type, ID, and parameter payload" } }, "description": "GetTemplateMappingResponse contains a single device mapping with its parameter values.", "example": { "mappings": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ] } }, "GetTemplateResponse": { "title": "GetTemplateResponse", "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier of the configuration template." }, "name": { "type": "string", "description": "The name of the configuration template." }, "description": { "type": "string", "description": "The description of the configuration template." }, "format": { "type": "string", "description": "Format of the configuration template (e.g., CLI, XML)." }, "template": { "type": "string", "description": "The configuration template content in jinja syntax." }, "variablesdef": { "type": "string", "description": "The variables definition for the template, containing JSON variable schema definitions in string format." } }, "description": "GetTemplateResponse represents the response containing a single configuration template's information.\nIt includes the essential details of the requested configuration template.", "example": { "uuid": "string", "name": "string", "description": "string", "format": "string", "template": "string", "variablesdef": "string" } }, "GetValidateResultByDeviceResponse": { "title": "GetValidateResultByDeviceResponse", "type": "object", "properties": { "template_id": { "type": "string", "description": "UUID of the template that was validated" }, "template_name": { "type": "string", "description": "Name of the template that was validated" }, "device_id": { "type": "string", "description": "UUID of the device for this validation result" }, "device_name": { "type": "string", "description": "Hostname or name of the device" }, "status": { "type": "string", "description": "Status of the validation for this device: SUCCESS, FAILURE, or IN_PROGRESS" }, "validated_config": { "type": "string", "description": "The validated configuration for this device (if validation succeeded)" }, "message": { "type": "string", "description": "Descriptive message with validation details or error information for this device" } }, "description": "GetValidateResultByDeviceResponse contains the validation result for a specific device.\nReturns the device-specific validation result including validated configuration and status.", "example": { "template_id": "string", "template_name": "string", "device_id": "string", "device_name": "string", "status": "string", "validated_config": "string", "message": "string" } }, "GetValidateStatusResponse": { "title": "GetValidateStatusResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Overall status of the validation operation: SUCCESS, FAILURE, or IN_PROGRESS" }, "template_id": { "type": "string", "description": "UUID of the template that was validated" }, "template_name": { "type": "string", "description": "Name of the template that was validated" }, "device_validate_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceValidateStatus" }, "description": "Array of validation results, one per target device, containing validation status and error details" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the validation results" } }, "description": "GetValidateStatusResponse contains the validation results for all target devices.\nIncludes validation status and any errors found for each device.", "example": { "status": "string", "template_id": "string", "template_name": "string", "device_validate_status": [ { "id": "string", "name": "string", "status": "string", "message": "string" } ], "message": "string" } }, "GroupMnhaClusterRequest": { "title": "GroupMnhaClusterRequest", "required": [ "device_uuids" ], "type": "object", "properties": { "device_uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs to group into an MNHA cluster" } }, "description": "Request to group devices into an MNHA cluster", "example": { "device_uuids": [ "string" ] } }, "GroupMnhaClusterResponse": { "title": "GroupMnhaClusterResponse", "type": "object", "properties": { "mnha_cluster_id": { "type": "string", "description": "Unique identifier of the newly created MNHA cluster" } }, "description": "Response containing the MNHA cluster ID", "example": { "mnha_cluster_id": "string" } }, "IdpPacketLog": { "title": "IdpPacketLog", "type": "object", "properties": { "host": { "$ref": "#/components/schemas/IdpPacketLogHost2" }, "source_address": { "type": "string", "description": "Source IP address used when sending packet logs." }, "threshold_logging_interval": { "type": "string", "description": "Interval (in seconds) for threshold-based logging." }, "max_sessions": { "$ref": "#/components/schemas/IdpPacketLogMaxSessions" }, "total_memory": { "$ref": "#/components/schemas/IdpPacketLogTotalMemory" } }, "description": "Packet-log settings for an IDP sensor.", "example": { "host": { "ipaddr": "string", "port": "string" }, "source_address": "string", "threshold_logging_interval": "string", "max_sessions": { "percentage_value": "string" }, "total_memory": { "percentage_value": "string" } } }, "IdpPacketLogHost": { "title": "IdpPacketLogHost", "type": "object", "properties": { "ipaddr": { "type": "string", "description": "IP address of the packet-log destination host." }, "port": { "type": "string", "description": "Port of the packet-log destination host." } }, "description": "Destination host for IDP packet-log messages.", "example": { "ipaddr": "string", "port": "string" } }, "IdpPercentageValue": { "title": "IdpPercentageValue", "type": "object", "properties": { "percentage_value": { "type": "string", "description": "Value expressed as a percentage." } }, "description": "A percentage-based configuration value.", "example": { "percentage_value": "string" } }, "IdpSensorConfiguration": { "title": "IdpSensorConfiguration", "type": "object", "properties": { "packet_log": { "$ref": "#/components/schemas/IdpSensorConfigurationPacketLog" } }, "description": "IDP sensor-level configuration.", "example": { "packet_log": { "host": { "ipaddr": "string", "port": "string" }, "source_address": "string", "threshold_logging_interval": "string", "max_sessions": { "percentage_value": "string" }, "total_memory": { "percentage_value": "string" } } } }, "ListConfigVersionsResponse": { "title": "ListConfigVersionsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigVersion" }, "description": "Array of configuration version entries" }, "count": { "type": "integer", "description": "Total number of configuration versions", "format": "int32" } }, "description": "Response containing list of configuration versions for a device", "example": { "items": [ { "version_number": "string", "description": "string", "archived_timestamp": "string", "revision": "string" } ], "count": 1 } }, "ListTemplateMappingsResponse": { "title": "ListTemplateMappingsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateMapping" }, "description": "Array of device mappings, one per device/device-group associated with the template" }, "count": { "type": "integer", "description": "Total count of device mappings for this template", "format": "int32" } }, "description": "ListTemplateMappingsResponse contains the list of all device mappings for a template.\nReturns all device and device-group mappings with their parameter values.", "example": { "items": [ { "id": "string", "name": "string", "payload": { "example": "string" } } ], "count": 1 } }, "ListTemplatesResponse": { "title": "ListTemplatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateView" }, "description": "Items represents list of configuration templates" }, "count": { "type": "integer", "description": "The total count of configuration templates matching the query.", "format": "int32" } }, "description": "ListTemplatesResponse represents the response containing a list of configuration templates.\nIt also includes metadata such as the total count of templates matching the query.", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "format": "string" } ], "count": 1 } }, "MappingResult": { "title": "MappingResult", "type": "object", "properties": { "template_id": { "type": "string", "description": "UUID of the template that was associated" }, "device_uuid": { "type": "string", "description": "UUID of the device that was associated with the template" }, "status": { "type": "string", "description": "Status of this specific mapping: SUCCESS or FAILURE" }, "message": { "type": "string", "description": "Descriptive message with details or error information for this mapping" } }, "description": "MappingResult represents the outcome of a single template-device parameter mapping.\nContains success/failure status and details for each device mapping.", "example": { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } }, "apiOperationAction": { "title": "apiOperationAction", "enum": [ "CREATE", "UPDATE", "DELETE" ], "type": "string", "description": "OperationAction enum defines the type of CRUD operation to perform on template mappings.\n\n - CREATE: CREATE - Create a new template mapping\n - UPDATE: UPDATE - Update an existing template mapping\n - DELETE: DELETE - Delete an existing template mapping", "example": "CREATE" }, "OperationParam": { "title": "OperationParam", "type": "object", "properties": { "action": { "$ref": "#/components/schemas/apiOperationAction" }, "params": { "$ref": "#/components/schemas/OperationParamParams" } }, "description": "OperationParam defines a CRUD operation (create/update/delete) for template mappings.", "example": { "action": "CREATE", "params": { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } } }, "apiOutputFormat": { "title": "apiOutputFormat", "enum": [ "XML", "JSON", "TEXT" ], "type": "string", "description": "OutputFormat specifies the format for template preview and configuration output.\nDifferent formats may be better suited for different device types and use cases.\n\n - XML: XML - Hierarchical XML configuration format (default), suitable for most Juniper devices\n - JSON: JSON - JSON representation of the configuration for modern APIs\n - TEXT: TEXT - Plain text configuration commands (e.g., CLI set commands)", "example": "XML" }, "PreviewTemplateResponse": { "title": "PreviewTemplateResponse", "type": "object", "properties": { "preview_id": { "type": "string", "description": "Unique job identifier for the preview operation. Use this with GetTemplatePreviewStatus to retrieve the generated configuration." }, "status": { "type": "string", "description": "Status of the preview request: SUCCESS (preview generation started) or FAILURE (preview could not be initiated)" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the preview operation" } }, "description": "PreviewTemplateResponse contains the result of initiating a template preview generation.\nProvides a job identifier for retrieving the generated configuration preview.", "example": { "preview_id": "string", "status": "string", "message": "string" } }, "ProxyServerConfig": { "title": "ProxyServerConfig", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the proxy server configuration", "readOnly": true }, "name": { "type": "string", "description": "Name of the proxy server configuration", "readOnly": true }, "use_dhcp": { "type": "boolean", "description": "Whether to use DHCP for proxy server configuration" }, "hostname": { "type": "string", "description": "Hostname or IP address of the proxy server" }, "port": { "type": "integer", "description": "Port number of the proxy server", "format": "int32" }, "username": { "type": "string", "description": "Username for proxy server authentication" }, "password": { "type": "string", "description": "Password for proxy server authentication" } }, "description": "Proxy server configuration", "example": { "id": "string", "name": "string", "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } }, "ProxyServerConfigInput": { "title": "ProxyServerConfigInput", "type": "object", "properties": { "use_dhcp": { "type": "boolean", "description": "Whether to use DHCP for proxy server configuration" }, "hostname": { "type": "string", "description": "Hostname or IP address of the proxy server" }, "port": { "type": "integer", "description": "Port number of the proxy server", "format": "int32" }, "username": { "type": "string", "description": "Username for proxy server authentication" }, "password": { "type": "string", "description": "Password for proxy server authentication. This field is write-only and will not be included in responses." } }, "description": "Input fields for creating or updating proxy server configuration", "example": { "use_dhcp": true, "hostname": "string", "port": 1, "username": "string", "password": "string" } }, "RebootDeviceRequest": { "title": "RebootDeviceRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs to reboot. Supports both single and multiple devices reboot operation." } }, "description": "Request containing array of device UUIDs for reboot operation.", "example": { "uuids": [ "string" ] } }, "RebootDevicesResponse": { "title": "RebootDevicesResponse", "type": "object", "properties": { "reboot_id": { "type": "string", "description": "Unique identifier for the reboot operation. Use this to query operation status." } }, "description": "Response containing reboot operation ID", "example": { "reboot_id": "string" } }, "RollbackConfigVersionResponse": { "title": "RollbackConfigVersionResponse", "type": "object", "properties": { "config_rollback_id": { "type": "string", "description": "Unique identifier for the configuration rollback operation. Use this to query operation status." } }, "description": "Response containing rollback operation ID and initiation status", "example": { "config_rollback_id": "string" } }, "RoutingInstanceConfiguration": { "title": "RoutingInstanceConfiguration", "type": "object", "properties": { "standalone": { "type": "string", "description": "Routing instance name for standalone device" }, "cluster": { "$ref": "#/components/schemas/RoutingInstanceConfigurationCluster" } }, "description": "Routing instance configuration for standalone or cluster devices", "example": { "standalone": "string", "cluster": { "node0": "string", "node1": "string" } } }, "SaveTemplateMappingsResponse": { "title": "SaveTemplateMappingsResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Operation status: SUCCESS, FAILURE, or PARTIAL_SUCCESS (when some mappings succeed and others fail)" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the operation result" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/MappingResult" }, "description": "Array of individual mapping results, one per device-template mapping attempted" } }, "description": "SaveTemplateMappingsResponse contains the result of saving template-device parameter mappings.\nThis response indicates whether the mappings were successfully saved and provides details for each device.", "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } }, "apiStatus": { "title": "apiStatus", "enum": [ "FAILURE", "SUCCESS", "INPROGRESS" ], "type": "string", "description": "Status enum indicates the outcome of an operation.\n\n - FAILURE: FAILURE - Operation failed completely\n - SUCCESS: SUCCESS - Operation completed successfully\n - INPROGRESS: INPROGRESS - Operation is currently executing", "example": "FAILURE" }, "SyncDeviceRequest": { "title": "SyncDeviceRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs to sync. Supports both single and multiple device sync operation." } }, "description": "Request containing array of device UUIDs for bulk operations.", "example": { "uuids": [ "string" ] } }, "SyncDevicesResponse": { "title": "SyncDevicesResponse", "type": "object", "properties": { "sync_id": { "type": "string", "description": "Unique identifier for the sync operation. Use this to query operation status." } }, "description": "Response containing sync operation ID and status", "example": { "sync_id": "string" } }, "SyncMnhaDevicesResponse": { "title": "SyncMnhaDevicesResponse", "type": "object", "properties": { "mnha_sync_id": { "type": "string", "description": "Unique identifier for the MNHA sync operation. Use this to query operation status." } }, "description": "Response containing MNHA sync operation ID for tracking the operation", "example": { "mnha_sync_id": "string" } }, "TemplateMapping": { "title": "TemplateMapping", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier (UUID) of the device" }, "name": { "type": "string", "description": "Name(hostname) of the device" }, "payload": { "type": "object", "description": "JSON object containing template variable values specific to this device/group" } }, "description": "TemplateMapping represents a single device-to-template parameter mapping.\nContains device type, ID, and associated parameter values.", "example": { "id": "string", "name": "string", "payload": { "example": "string" } } }, "TemplateView": { "title": "TemplateView", "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier of the configuration template." }, "name": { "type": "string" }, "description": { "type": "string", "description": "The description of the configuration template." }, "format": { "type": "string", "description": "Format of the configuration template (e.g., CLI, XML)." } }, "example": { "uuid": "string", "name": "string", "description": "string", "format": "string" } }, "TriggerDiscoverDevicesResponse": { "title": "TriggerDiscoverDevicesResponse", "type": "object", "properties": { "discover_devices_id": { "type": "string", "description": "Unique identifier for the device discovery operation. Use this to query operation status." } }, "description": "Response containing the device discovery operation ID", "example": { "discover_devices_id": "string" } }, "UngroupMnhaClustersResponse": { "title": "UngroupMnhaClustersResponse", "type": "object", "properties": { "device_uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs that were part of the ungrouped MNHA cluster" } }, "description": "Response containing the child device UUIDs from the ungrouped cluster", "example": { "device_uuids": [ "string" ] } }, "UpdateTemplateMappingResponse": { "title": "UpdateTemplateMappingResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Operation status: SUCCESS, FAILURE, or PARTIAL_SUCCESS (when some mappings succeed and others fail)" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the operation result" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/MappingResult" }, "description": "Array of individual mapping results, one per device-template mapping attempted" } }, "description": "UpdateTemplateMappingResponse contains the result of updating a device mapping.", "example": { "status": "string", "message": "string", "mappings": [ { "template_id": "string", "device_uuid": "string", "status": "string", "message": "string" } ] } }, "ValidateTemplateResponse": { "title": "ValidateTemplateResponse", "type": "object", "properties": { "validate_id": { "type": "string", "description": "Unique job identifier for the validation operation. Use this with GetTemplateValidateStatus to retrieve validation results." }, "status": { "type": "string", "description": "Status of the validation request: SUCCESS (validation started) or FAILURE (validation could not be initiated)" }, "message": { "type": "string", "description": "Descriptive message providing additional context about the validation operation" }, "template_id": { "type": "string", "description": "UUID of the template being validated" }, "template_name": { "type": "string", "description": "Name of the template being validated" } }, "description": "ValidateTemplateResponse contains the result of initiating a template validation.\nProvides a job identifier for retrieving validation results and template information.", "example": { "validate_id": "string", "status": "string", "message": "string", "template_id": "string", "template_name": "string" } }, "WorkflowDefinitionUploadRequest": { "title": "WorkflowDefinitionUploadRequest", "type": "object", "properties": { "definition_file": { "type": "string", "description": "YAML file containing workflow definition. For REST API: upload as multipart/form-data in 'definition_file' form field. Please refer to the documentation for details on how to write the YAML file and its fields." } }, "description": "For multipart/form-data uploads, use form field 'definition_file' for the YAML file", "example": { "definition_file": "string" } }, "WorkflowDefinitionUploadResponse": { "title": "WorkflowDefinitionUploadResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the upload operation (SUCCESS, FAILURE)" }, "resource_type": { "type": "string", "description": "Type of the resource created from the workflow definition" }, "resource_id": { "type": "string", "description": "Unique identifier of the created resource" }, "message": { "type": "string", "description": "Additional information about the upload operation" } }, "description": "WorkflowDefinitionUploadResponse represents the response for workflow definition upload.", "example": { "status": "string", "resource_type": "string", "resource_id": "string", "message": "string" } }, "protobufNullValue": { "title": "protobufNullValue", "enum": [ "NULL_VALUE" ], "type": "string", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.", "example": "NULL_VALUE" }, "CSVTemplateDownloadRequest": { "title": "CSVTemplateDownloadRequest", "type": "object", "properties": { "device_uuids": { "type": "array", "items": { "type": "string" }, "description": "List of device UUIDs to include in the CSV template. If empty, includes all devices associated with the template." } }, "description": "CSVTemplateDownloadRequest represents a request to download a CSV template.", "example": { "device_uuids": [ "string" ] } }, "DeployTemplateRequest": { "title": "DeployTemplateRequest", "type": "object", "properties": { "deployment_object": { "$ref": "#/components/schemas/DeployTemplateRequestDeploymentObject" } }, "description": "DeployTemplateRequest represents a request to deploy a configuration template.\nThis message contains the template identifier and deployment configuration parameters.", "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } }, "PreviewTemplateRequest": { "title": "PreviewTemplateRequest", "type": "object", "properties": { "deployment_object": { "$ref": "#/components/schemas/PreviewTemplateRequestDeploymentObject" }, "format": { "$ref": "#/components/schemas/apiOutputFormat" } }, "description": "PreviewTemplateRequest represents a request to generate a template configuration preview.\nThis message contains template parameters and output format preferences for preview generation.", "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } }, "format": "XML" } }, "SaveTemplateMappingsRequest": { "title": "SaveTemplateMappingsRequest", "type": "object", "properties": { "global_params": { "type": "object", "description": "Global template parameters that apply to all devices. These values will be overrided by device-specific parameters(payload field) when conflicts occur." }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/OperationParam" }, "description": "Array of CRUD operations to perform on template mappings. Each OperationParam specifies an action (CREATE/UPDATE/DELETE), device type, device ID, and optional payload. Use this field for batch CRUD operations." } }, "description": "SaveTemplateMappingsRequest represents a request to save parameter mappings for a template.\nThis message contains device-specific parameter values and global parameters for template deployment. \nSupports CRUD operations (create/update/delete) on template mappings through the operations field.", "example": { "global_params": { "example": "string" }, "operations": [ { "action": "CREATE", "params": { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } } ] } }, "UpdateTemplateMappingRequest": { "title": "UpdateTemplateMappingRequest", "required": [ "payload" ], "type": "object", "properties": { "payload": { "type": "object", "description": "JSON object containing updated template variable values for this device/group" } }, "description": "UpdateTemplateMappingRequest represents a request to update a device mapping.", "example": { "payload": { "example": "string" } } }, "ValidateTemplateRequest": { "title": "ValidateTemplateRequest", "type": "object", "properties": { "deployment_object": { "$ref": "#/components/schemas/ValidateTemplateRequestDeploymentObject" } }, "description": "ValidateTemplateRequest represents a request to validate template configuration.\nThis message contains template parameters for validation against template schema and syntax.", "example": { "deployment_object": { "params": [ { "type": "DEVICE", "id": "string", "payload": { "example": "string" } } ], "global_params": { "example": "string" } } } }, "ApiV1DevicesGetBootstrapConfigRequest": { "title": "ApiV1DevicesGetBootstrapConfigRequest", "type": "object", "properties": { "enable_proxy": { "type": "boolean", "description": "When true, enables proxy server (proxy_default) for device connectivity. When false, clears any existing proxy server configuration from the device." }, "routing_instance_configuration": { "$ref": "#/components/schemas/GetBootstrapConfigInputRoutingInstanceConfiguration" } } }, "ApiV1DevicesRebootRequest": { "title": "ApiV1DevicesRebootRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs to reboot. Supports both single and multiple devices reboot operation." } } }, "ApiV1DevicesSyncRequest": { "title": "ApiV1DevicesSyncRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Array of device UUIDs to sync. Supports both single and multiple device sync operation." } } }, "ApiV1TemplatesCsvUploadResponse": { "title": "ApiV1TemplatesCsvUploadResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Status of the upload operation (SUCCESS, FAILURE, PARTIAL_SUCCESS)" }, "message": { "type": "string", "description": "Message describing the overall upload result" }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationResult" }, "description": "List of device-template association results" }, "template_name": { "type": "string", "description": "Name of the configuration template" }, "template_id": { "type": "string", "description": "UUID of the configuration template" }, "total_records": { "type": "integer", "description": "Total number of records processed from the CSV file", "format": "int32" }, "error_message": { "type": "string", "description": "Error message if the upload operation failed (empty on success)" } } }, "DeployTemplateRequestDeploymentObject": { "title": "DeployTemplateRequestDeploymentObject", "type": "object", "properties": { "params": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceParam" }, "description": "Array of device-specific parameter mappings. Each DeviceParam contains device type (DEVICE/DEVICE_GROUP), device ID, and payload with template variable values." }, "global_params": { "type": "object", "description": "Global parameters that apply to all devices in the deployment." } } }, "GetBootstrapConfigInputRoutingInstanceConfiguration": { "title": "GetBootstrapConfigInputRoutingInstanceConfiguration", "type": "object", "properties": { "standalone": { "type": "string", "description": "Routing instance name for standalone device" }, "cluster": { "$ref": "#/components/schemas/RoutingInstanceConfigurationCluster" } } }, "IdpPacketLogHost2": { "title": "IdpPacketLogHost2", "type": "object", "properties": { "ipaddr": { "type": "string", "description": "IP address of the packet-log destination host." }, "port": { "type": "string", "description": "Port of the packet-log destination host." } } }, "IdpPacketLogMaxSessions": { "title": "IdpPacketLogMaxSessions", "type": "object", "properties": { "percentage_value": { "type": "string", "description": "Value expressed as a percentage." } } }, "IdpPacketLogTotalMemory": { "title": "IdpPacketLogTotalMemory", "type": "object", "properties": { "percentage_value": { "type": "string", "description": "Value expressed as a percentage." } } }, "IdpSensorConfigurationPacketLog": { "title": "IdpSensorConfigurationPacketLog", "type": "object", "properties": { "host": { "$ref": "#/components/schemas/IdpPacketLogHost2" }, "source_address": { "type": "string", "description": "Source IP address used when sending packet logs." }, "threshold_logging_interval": { "type": "string", "description": "Interval (in seconds) for threshold-based logging." }, "max_sessions": { "$ref": "#/components/schemas/IdpPacketLogMaxSessions" }, "total_memory": { "$ref": "#/components/schemas/IdpPacketLogTotalMemory" } } }, "OperationParamParams": { "title": "OperationParamParams", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiDeviceType" }, "id": { "type": "string", "description": "Unique identifier (UUID) of the target device, device group, or cluster" }, "payload": { "type": "object", "description": "JSON object containing template variable values specific to this target. These values override global_params for this device. Sample payload for banner template: {\"message\":\"banner-message\"}" } } }, "PreviewTemplateRequestDeploymentObject": { "title": "PreviewTemplateRequestDeploymentObject", "type": "object", "properties": { "params": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceParam" }, "description": "Array of device-specific parameter mappings. Each DeviceParam contains device type (DEVICE/DEVICE_GROUP), device ID, and payload with template variable values." }, "global_params": { "type": "object", "description": "Global parameters that apply to all devices in the deployment." } } }, "RoutingInstanceConfigurationCluster": { "title": "RoutingInstanceConfigurationCluster", "type": "object", "properties": { "node0": { "type": "string", "description": "Routing instance name for cluster node 0" }, "node1": { "type": "string", "description": "Routing instance name for cluster node 1" } } }, "ValidateTemplateRequestDeploymentObject": { "title": "ValidateTemplateRequestDeploymentObject", "type": "object", "properties": { "params": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceParam" }, "description": "Array of device-specific parameter mappings. Each DeviceParam contains device type (DEVICE/DEVICE_GROUP), device ID, and payload with template variable values." }, "global_params": { "type": "object", "description": "Global parameters that apply to all devices in the deployment." } } }, "ActivationConfig": { "title": "ActivationConfig", "type": "object", "properties": { "config_format": { "type": "string", "description": "Format of the configuration content. Typically 'text' for CLI commands or 'xml' for XML configuration. Determines how the device should interpret the config_contents field." }, "config_contents": { "type": "string", "description": "The actual configuration content to be applied to the device. Format depends on config_format field. For 'text' format, this contains CLI set commands. For 'xml' format, this contains hierarchical XML configuration." } }, "description": "Bootstrap configuration for device reactivation or reactivation, including format type and configuration content.", "example": { "config_format": "string", "config_contents": "string" } }, "BulkCreateDeviceRequest": { "title": "BulkCreateDeviceRequest", "required": [ "devices" ], "type": "object", "properties": { "ipv6": { "type": "boolean", "description": "Enable IPv6 for the devices. Defaults to false. Supported only in Juniper Security Director Cloud." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/BulkDeviceInfo" }, "description": "Devices to onboard. Each entry can be ZTP or BROWN_FIELD with its respective parameters." } }, "description": "Unified device onboarding request.", "example": { "ipv6": true, "devices": [ { "onboarding_type": "BROWN_FIELD", "serial_number": "string", "root_pwd": "string", "type": "STANDALONE", "device_count": 1 } ] } }, "BulkCreateDeviceResponse": { "title": "BulkCreateDeviceResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/BulkDeviceResult" }, "description": "List of devices with UUIDs and per-device onboarding status" } }, "description": "Batch device onboarding response with per-device status", "example": { "status": "FAILURE", "devices": [ { "uuid": "string", "serial_number": "string", "parent_id": "string", "status": "FAILURE", "message": "string", "device_type": "STANDALONE" } ] } }, "BulkDeviceInfo": { "title": "BulkDeviceInfo", "type": "object", "properties": { "onboarding_type": { "$ref": "#/components/schemas/IngOnboardingType" }, "serial_number": { "type": "string", "description": "Serial number of the device. Required when onboarding_type is ZTP." }, "root_pwd": { "type": "string", "description": "Root password for device authentication. Required when onboarding_type is ZTP." }, "type": { "$ref": "#/components/schemas/IngClusterType" }, "device_count": { "type": "integer", "description": "Number of device entries to create. Required when onboarding_type is BROWN_FIELD.", "format": "int32" } }, "description": "Single device onboarding entry. ZTP devices require serial_number and root_pwd and only supported in Security Director Cloud. BROWN_FIELD devices require type and device_count.", "example": { "onboarding_type": "BROWN_FIELD", "serial_number": "string", "root_pwd": "string", "type": "STANDALONE", "device_count": 1 } }, "BulkDeviceResult": { "title": "BulkDeviceResult", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier (UUID) of the device. Empty if device creation failed." }, "serial_number": { "type": "string", "description": "Serial number of the device. Populated for ZTP onboarding." }, "parent_id": { "type": "string", "description": "UUID of the parent MNHA device. Only populated for MNHA child devices." }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Failure message. Usually populated when device status is FAILURE." }, "device_type": { "$ref": "#/components/schemas/IngClusterType" } }, "description": "Per-device onboarding result", "example": { "uuid": "string", "serial_number": "string", "parent_id": "string", "status": "FAILURE", "message": "string", "device_type": "STANDALONE" } }, "BulkRemoveDevicesRequest": { "title": "BulkRemoveDevicesRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Device UUIDs to remove. For MNHA clusters, only the parent cluster UUID is accepted, child device UUIDs are not allowed." } }, "description": "Request to remove devices in batch", "example": { "uuids": [ "string" ] } }, "BulkRemoveDevicesResponse": { "title": "BulkRemoveDevicesResponse", "type": "object", "properties": { "remove_id": { "type": "string", "description": "Unique identifier for the remove device operation. Use this to query operation status via GetRemoveDeviceStatus." } }, "description": "Response containing the remove device operation ID", "example": { "remove_id": "string" } }, "IngCACertificateUpload": { "title": "IngCACertificateUpload", "type": "object", "properties": { "id": { "type": "string", "description": "CA profile name as reported by the device. Obtain this value from the missing_ca_certificate list in GetRMADeviceStatusV1 and pass it back unchanged so the system can match the uploaded certificate to the correct CA profile." }, "certificate_contents": { "type": "string", "description": "PEM-encoded CA certificate file contents." }, "ignore": { "type": "boolean", "description": "If true, mark this certificate as ignored instead of uploading it to the device." } }, "description": "CACertificateUpload describes a single CA certificate to upload or ignore.", "example": { "id": "string", "certificate_contents": "string", "ignore": true } }, "IngClusterType": { "title": "IngClusterType", "enum": [ "STANDALONE", "L2_CLUSTER", "MNHA" ], "type": "string", "description": "ClusterType enum defines the device cluster configuration type. Applicable only for BROWN_FIELD.\n\n - STANDALONE: STANDALONE - Single standalone device\n - L2_CLUSTER: L2_CLUSTER - Clustered device configuration\n - MNHA: MNHA - MNHA cluster device configuration", "example": "STANDALONE" }, "DefaultCACertificateConfig": { "title": "DefaultCACertificateConfig", "type": "object", "properties": { "ignore": { "type": "boolean", "description": "If true, skip generating default CA certificates on the device. If false (default), the system calls EnableDefaultCAProfile on DPM to push the default trusted CA bundle.", "default": false } }, "description": "Configuration for default CA certificate generation on the device.", "example": { "ignore": true } }, "DeleteDeviceInfo": { "title": "DeleteDeviceInfo", "type": "object", "properties": { "name": { "type": "string", "description": "Name or hostname of the device" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Status message. Contains error details on failure." } }, "description": "Per-device removal status", "example": { "name": "string", "status": "FAILURE", "message": "string" } }, "GetRMADeviceStatusResponse": { "title": "GetRMADeviceStatusResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Current RMA reactivation status: REACTIVATION_COMPLETED (device successfully reactivated), REACTIVATION_PENDING (waiting to start), REACTIVATION_FAILED (reactivation failed), REACTIVATION_IN_PROGRESS (currently reactivating)." }, "failure_reason": { "type": "string", "description": "Detailed failure reason if reactivation failed. Explains what went wrong during the reactivation process. Empty if status is not REACTIVATION_FAILED." }, "missing_ca_certificate": { "type": "array", "items": { "type": "string" }, "description": "Array of CA certificate names that are missing and required for device reactivation. These certificates must be added to the device model before reactivation can succeed." }, "missing_certificates": { "type": "array", "items": { "type": "string" }, "description": "Array of device certificate names that are missing and required for reactivation. These certificates must be restored or re-added to the device model." }, "missing_licenses": { "type": "array", "items": { "type": "string" }, "description": "Array of license keys that are missing and required for device reactivation. These licenses must be re-applied to the device model before reactivation." } }, "description": "Detailed RMA reactivation status including current status, failure reasons, and lists of missing resources (certificates, licenses) preventing reactivation.", "example": { "status": "string", "failure_reason": "string", "missing_ca_certificate": [ "string" ], "missing_certificates": [ "string" ], "missing_licenses": [ "string" ] } }, "GetRMAReactivationConfigResponse": { "title": "GetRMAReactivationConfigResponse", "type": "object", "properties": { "reactivation_config": { "$ref": "#/components/schemas/GetRMAReactivationConfigResponseReactivationConfig" } }, "description": "Bootstrap reactivation configuration to be applied to the replacement device during RMA reactivation process.", "example": { "reactivation_config": { "config_format": "string", "config_contents": "string" } } }, "GetReactivationStatusResponse": { "title": "GetReactivationStatusResponse", "type": "object", "properties": { "status": { "type": "string", "description": "Overall operation status: SUCCESS (all steps completed), FAILURE (operation failed), IN_PROGRESS (currently executing), PARTIAL_SUCCESS (some steps succeeded, some failed)." }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/Step" }, "description": "Array of execution steps with status for each phase of the operation. Provides granular visibility into operation progress and helps identify failure points." } }, "description": "Detailed status information for an RMA reactivation including step-by-step execution details and overall status.", "example": { "status": "string", "steps": [ { "description": "string", "status": "string", "status_message": "string" } ] } }, "GetRemoveDeviceStatusResponse": { "title": "GetRemoveDeviceStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "remove_device_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteDeviceInfo" }, "description": "Per-device removal results with status for each device" } }, "description": "Response containing remove device operation status and results", "example": { "status": "FAILURE", "remove_device_status": [ { "name": "string", "status": "FAILURE", "message": "string" } ] } }, "IngLicenseUpload": { "title": "IngLicenseUpload", "type": "object", "properties": { "license_contents": { "type": "string", "description": "License file contents." }, "ignore": { "type": "boolean", "description": "If true, mark this license as ignored instead of uploading it to the device." } }, "description": "LicenseUpload describes a single license to upload or ignore.", "example": { "license_contents": "string", "ignore": true } }, "IngLocalCertificateUpload": { "title": "IngLocalCertificateUpload", "type": "object", "properties": { "id": { "type": "string", "description": "Local certificate name as reported by the device. Obtain this value from the missing_certificates list in GetRMADeviceStatusV1 and pass it back unchanged so the system can match the uploaded certificate and key to the correct identity on the device." }, "certificate_contents": { "type": "string", "description": "PEM-encoded certificate file contents." }, "key_contents": { "type": "string", "description": "PEM-encoded private key file contents." }, "passphrase": { "type": "string", "description": "Optional passphrase protecting the private key." }, "ignore": { "type": "boolean", "description": "If true, mark this certificate as ignored instead of uploading it to the device." } }, "description": "LocalCertificateUpload describes a single local certificate (+key) to upload or ignore.", "example": { "id": "string", "certificate_contents": "string", "key_contents": "string", "passphrase": "string", "ignore": true } }, "IngOnboardingType": { "title": "IngOnboardingType", "enum": [ "BROWN_FIELD", "ZTP" ], "type": "string", "description": "OnboardingType enum defines the onboarding method for a device.\n\n - BROWN_FIELD: Manual onboarding (default). Requires type and device_count.\n - ZTP: Zero Touch Provisioning. Requires serial_number and root_pwd.", "example": "BROWN_FIELD" }, "PutDeviceInRMAResponse": { "title": "PutDeviceInRMAResponse", "type": "object", "properties": { "device_id": { "type": "string", "description": "The device UUID that was processed." }, "host_name": { "type": "string", "description": "The hostname of the device that was processed." }, "message": { "type": "string", "description": "Human-readable message describing the result of the RMA operation or providing error details." } }, "description": "Response after putting a single device into RMA state, containing request data and operation result.", "example": { "device_id": "string", "host_name": "string", "message": "string" } }, "ReactivateRMADeviceInput": { "title": "ReactivateRMADeviceInput", "type": "object", "properties": { "ca_certificates": { "type": "array", "items": { "$ref": "#/components/schemas/IngCACertificateUpload" }, "description": "List of CA certificates to upload and install on the device, or mark as ignored." }, "local_certificates": { "type": "array", "items": { "$ref": "#/components/schemas/IngLocalCertificateUpload" }, "description": "List of local certificates (with private keys) to upload and install on the device, or mark as ignored." }, "license": { "$ref": "#/components/schemas/ReactivateRMADeviceInputLicense" }, "default_ca": { "$ref": "#/components/schemas/ReactivateRMADeviceInputDefaultCa" } }, "description": "Optional body for the reactivate endpoint. When certificate/license fields are provided, the system uploads and installs them on the device and then triggers reactivation. When empty, the system retries a previously failed reactivation or discovery job.", "example": { "ca_certificates": [ { "id": "string", "certificate_contents": "string", "ignore": true } ], "local_certificates": [ { "id": "string", "certificate_contents": "string", "key_contents": "string", "passphrase": "string", "ignore": true } ], "license": { "license_contents": "string", "ignore": true }, "default_ca": { "ignore": true } } }, "ReactivateRMADeviceResponse": { "title": "ReactivateRMADeviceResponse", "type": "object", "properties": { "reactivation_id": { "type": "string", "description": "Reactivation ID of the initiated job. Use GetReactivationStatusV1 with this ID to poll progress." } }, "description": "Response from the reactivate endpoint. A 200 OK always contains a reactivation_id for tracking. Use GetReactivationStatusV1 to poll progress. Error conditions (invalid state, already completed, etc.) return appropriate HTTP error codes.", "example": { "reactivation_id": "string" } }, "SetupRMADeviceResponse": { "title": "SetupRMADeviceResponse", "type": "object", "properties": { "message": { "type": "string", "description": "Human-readable message describing the result of the setup operation." }, "state": { "type": "string", "description": "State of the task" } }, "description": "Response after setting up a device for RMA reactivation.", "example": { "message": "string", "state": "string" } }, "Step": { "title": "Step", "type": "object", "properties": { "description": { "type": "string", "description": "Human-readable description of this execution step (e.g., 'Validate device state', 'Remove bootstrap configuration', 'Update RMA flag')." }, "status": { "type": "string", "description": "Current status of this step: SUCCESS (completed successfully), FAILURE (failed), IN_PROGRESS (currently executing), PENDING (not yet started), SKIPPED (bypassed)." }, "status_message": { "type": "string", "description": "Detailed message explaining the step's status, providing additional context, error details, or success information." } }, "description": "Individual execution step within an RMA operation, showing description, status, and detailed status message.", "example": { "description": "string", "status": "string", "status_message": "string" } }, "SetupRMADeviceRequest": { "title": "SetupRMADeviceRequest", "type": "object", "properties": { "skip_password_from_config": { "type": "boolean", "description": "Skip the root password to be set from SD during the reactivation. When enabled, root password on the device will not be updated from the existing config.", "default": false } }, "description": "Request to setup a device for RMA reactivation, preparing it for adoption by new hardware. The device_id is specified in the URI path.", "example": { "skip_password_from_config": true } }, "ApiV1DevicesCreateRequest": { "title": "ApiV1DevicesCreateRequest", "required": [ "devices" ], "type": "object", "properties": { "ipv6": { "type": "boolean", "description": "Enable IPv6 for the devices. Defaults to false. Supported only in Juniper Security Director Cloud." }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/BulkDeviceInfo" }, "description": "Devices to onboard. Each entry can be ZTP or BROWN_FIELD with its respective parameters." } } }, "ApiV1DevicesRemoveRequest": { "title": "ApiV1DevicesRemoveRequest", "required": [ "uuids" ], "type": "object", "properties": { "uuids": { "type": "array", "items": { "type": "string" }, "description": "Device UUIDs to remove. For MNHA clusters, only the parent cluster UUID is accepted, child device UUIDs are not allowed." } } }, "ApiV1DevicesRmaReactivateRequest": { "title": "ApiV1DevicesRmaReactivateRequest", "type": "object", "properties": { "ca_certificates": { "type": "array", "items": { "$ref": "#/components/schemas/IngCACertificateUpload" }, "description": "List of CA certificates to upload and install on the device, or mark as ignored." }, "local_certificates": { "type": "array", "items": { "$ref": "#/components/schemas/IngLocalCertificateUpload" }, "description": "List of local certificates (with private keys) to upload and install on the device, or mark as ignored." }, "license": { "$ref": "#/components/schemas/ReactivateRMADeviceInputLicense" }, "default_ca": { "$ref": "#/components/schemas/ReactivateRMADeviceInputDefaultCa" } } }, "GetRMAReactivationConfigResponseReactivationConfig": { "title": "GetRMAReactivationConfigResponseReactivationConfig", "type": "object", "properties": { "config_format": { "type": "string", "description": "Format of the configuration content. Typically 'text' for CLI commands or 'xml' for XML configuration. Determines how the device should interpret the config_contents field." }, "config_contents": { "type": "string", "description": "The actual configuration content to be applied to the device. Format depends on config_format field. For 'text' format, this contains CLI set commands. For 'xml' format, this contains hierarchical XML configuration." } } }, "ReactivateRMADeviceInputDefaultCa": { "title": "ReactivateRMADeviceInputDefaultCa", "type": "object", "properties": { "ignore": { "type": "boolean", "description": "If true, skip generating default CA certificates on the device. If false (default), the system calls EnableDefaultCAProfile on DPM to push the default trusted CA bundle.", "default": false } } }, "ReactivateRMADeviceInputLicense": { "title": "ReactivateRMADeviceInputLicense", "type": "object", "properties": { "license_contents": { "type": "string", "description": "License file contents." }, "ignore": { "type": "boolean", "description": "If true, mark this license as ignored instead of uploading it to the device." } } }, "CFNotificationOptionsCFNotificationType": { "title": "CFNotificationOptionsCFNotificationType", "enum": [ "PROTOCOL", "MESSAGE", "NONE" ], "type": "string", "description": "CFNotificationType specifies the method used to deliver virus detection notifications.\n\n - PROTOCOL: Notification is sent via protocol-level mechanism.\n - MESSAGE: Notification is sent as a message.\n - NONE: No notification is sent.", "example": "PROTOCOL" }, "CFProfileOptionsCFAction": { "title": "CFProfileOptionsCFAction", "enum": [ "NO_ACTION", "BLOCK", "CLOSE_CLIENT_AND_SERVER", "CLOSE_CLIENT", "CLOSE_SERVER" ], "type": "string", "description": "Action specifies the enforcement action to be taken when a policy rule is triggered.\n\n - NO_ACTION: No action, policy is logged only\n - BLOCK: Block the traffic and terminate the connection\n - CLOSE_CLIENT_AND_SERVER: Close both client and server connections\n - CLOSE_CLIENT: Close the client connection only\n - CLOSE_SERVER: Close the server connection only", "example": "NO_ACTION" }, "CFProfileOptionsCFDirection": { "title": "CFProfileOptionsCFDirection", "enum": [ "DOWNLOAD", "UPLOAD", "ANY" ], "type": "string", "description": "Direction specifies the traffic flow direction for policy enforcement.\n\n - DOWNLOAD: Incoming/download traffic direction\n - UPLOAD: Outgoing/upload traffic direction\n - ANY: Both incoming and outgoing traffic directions", "example": "DOWNLOAD" }, "HttpProtocolClientNotifyType": { "title": "HttpProtocolClientNotifyType", "enum": [ "CLIENT_NOTIFY_UNSPECIFIED", "NONE", "REDIRECT_URL", "MESSAGE" ], "type": "string", "example": "CLIENT_NOTIFY_UNSPECIFIED" }, "HttpProtocolMalwareAction": { "title": "HttpProtocolMalwareAction", "enum": [ "MALWARE_ACTION_UNSPECIFIED", "PERMIT", "BLOCK" ], "type": "string", "example": "MALWARE_ACTION_UNSPECIFIED" }, "AamwFallBackOptions": { "title": "AamwFallBackOptions", "type": "object", "properties": { "action": { "type": "string", "description": "Default fallback action. Allowed values: permit, block" }, "notification": { "type": "string", "description": "Notification setting for fallback" }, "service_not_ready_action": { "type": "string", "description": "Action when service is not ready" }, "service_not_ready_notification": { "type": "string", "description": "Notification when service is not ready" }, "invalid_content_size_action": { "type": "string", "description": "Action for invalid content size" }, "invalid_content_size_notification": { "type": "string", "description": "Notification for invalid content size" }, "out_of_resources_action": { "type": "string", "description": "Action when out of resources" }, "out_of_resources_notification": { "type": "string", "description": "Notification when out of resources" }, "verdict_timeout_action": { "type": "string", "description": "Action when verdict times out" }, "verdict_timeout_notification": { "type": "string", "description": "Notification when verdict times out" }, "submission_timeout_action": { "type": "string", "description": "Action when submission times out" }, "submission_timeout_notification": { "type": "string", "description": "Notification when submission times out" }, "unknown_file_action": { "type": "string", "description": "Action for unknown file type" }, "unknown_file_notification": { "type": "string", "description": "Notification for unknown file type" } }, "description": "Fallback options for advanced antimalware when verdict is unavailable", "example": { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } }, "AamwImapSmtpSmbProtocol": { "title": "AamwImapSmtpSmbProtocol", "type": "object", "properties": { "inspection_profile": { "type": "string", "description": "Name of the inspection profile to apply" }, "notification": { "type": "string", "description": "Notification setting" }, "action": { "type": "string", "description": "Action to take. Allowed values: permit, block" } }, "description": "Protocol inspection settings for IMAP, SMTP, and SMB protocols", "example": { "inspection_profile": "string", "notification": "string", "action": "string" } }, "AamwProfile": { "title": "AamwProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Name of the AAMW profile object" }, "description": { "type": "string", "description": "Description of the object" }, "verdict_threshold": { "type": "string", "description": "Threshold value for malware detection. Accepts integer values between 0 and 10, or the string 'recommended'. Files with a verdict rating at or above this threshold are classified as malware." }, "http_protocol": { "$ref": "#/components/schemas/AamwProfileHttpProtocol" }, "additional_logging": { "$ref": "#/components/schemas/AamwProfileAdditionalLogging" }, "smtp_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "SMTP protocol information" }, "smb_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "SMB protocol information" }, "imap_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "IMAP protocol information" }, "fallback_options": { "type": "array", "items": { "$ref": "#/components/schemas/AamwFallBackOptions" }, "description": "Fallback option information" } }, "description": "Advanced Anti-Malware (AAMW) profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } }, "AamwProfileInput": { "title": "AamwProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the AAMW profile object" }, "description": { "type": "string", "description": "Description of the object" }, "verdict_threshold": { "type": "string", "description": "Threshold value for malware detection. Accepts integer values between 0 and 10, or the string 'recommended'. Files with a verdict rating at or above this threshold are classified as malware." }, "http_protocol": { "$ref": "#/components/schemas/AamwProfileInputHttpProtocol" }, "additional_logging": { "$ref": "#/components/schemas/AamwProfileInputAdditionalLogging" }, "smtp_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "SMTP protocol information" }, "smb_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "SMB protocol information" }, "imap_protocol": { "type": "array", "items": { "$ref": "#/components/schemas/AamwImapSmtpSmbProtocol" }, "description": "IMAP protocol information" }, "fallback_options": { "type": "array", "items": { "$ref": "#/components/schemas/AamwFallBackOptions" }, "description": "Fallback option information" } }, "description": "Advanced Anti-Malware (AAMW) profile input object", "example": { "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } }, "AdditionalLogging": { "title": "AdditionalLogging", "type": "object", "properties": { "files_below_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files below the verdict threshold", "default": false }, "blocklist": { "type": "boolean", "description": "When true, enables logging of block list hits", "default": false }, "allowlist": { "type": "boolean", "description": "When true, enables logging of allow list hits", "default": false } }, "description": "Advanced antimalware additional logging settings", "example": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true } }, "AdvancedSettings": { "title": "AdvancedSettings", "type": "object", "properties": { "service_offload": { "type": "boolean", "description": "Service Offload", "default": false }, "destination_address_translation": { "type": "string", "description": "Destination Address Translation. Allowed values: [DROP_TRANSLATED, DROP_UNTRANSLATED]" }, "redirect": { "type": "string", "description": "Application-services - WX redirection. Allowed values: [REDIRECT_WX, REVERSE_REDIRECT_WX]" }, "tcp_syn_check": { "type": "boolean", "description": "Reject TCP segments with non-SYN flags that do not belong to an established session", "default": false }, "tcp_seq_check": { "type": "boolean", "description": "Enable to monitor the TCP byte sequence counter and to validate the trusted acknowledgment number against the untrusted sequence number.", "default": false }, "windows_scale_check": { "type": "boolean", "description": "Enable to increase the network transmission speed.", "default": false }, "initial_tcp_mss": { "type": "string", "description": "The TCP maximum segment size (MSS) for packets arriving at the ingress interface (initial direction). If the value in the packet is higher than the one you provide, the configured value overrides the TCP MSS value in the incoming packet. The range is 64 through 65535." }, "reverse_tcp_mss": { "type": "string", "description": "The TCP maximum segment size (MSS) for packets that match a specific policy and travel in the reverse direction of a session. If the value in the packet is higher than the one you select, the configured value replaces the TCP MSS value. The range is 64 through 65535" }, "captive_portal_name": { "type": "string", "description": "Captive Portal Name during Config Import" } }, "description": "Specify advanced settings", "example": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } }, "Authentication": { "title": "Authentication", "type": "object", "properties": { "authentication_type": { "type": "string", "description": "Type of firewall authentication. Allowed values: [NONE, PASSTHROUGH, WEB_AUTHENTICATION, USER_FIREWALL, INFRANET_AUTHENTICATION]" }, "push_to_jims": { "type": "boolean", "description": "Push to JIMS", "default": false }, "pass_through_options": { "$ref": "#/components/schemas/AuthenticationPassThroughOptions" }, "web_options": { "type": "array", "items": { "type": "string" }, "description": "Specify the options related to web authentication type" }, "userfw_options": { "$ref": "#/components/schemas/AuthenticationUserfwOptions" }, "infranet_options": { "$ref": "#/components/schemas/AuthenticationInfranetOptions" } }, "description": "Authentication tab", "example": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } } }, "AuthenticationAttributes": { "title": "AuthenticationAttributes", "type": "object", "properties": { "web_redirect": { "type": "boolean", "description": "Web redirect", "default": false }, "web_redirect_to_https": { "type": "boolean", "description": "Web redirect to https", "default": false }, "web_authentication_server": { "type": "string", "description": "Firewall Web authentication server" }, "ssl_termination_profile": { "type": "string", "description": "Specify SSL termination profileused to the SSL offload" }, "auth_only_browser": { "type": "boolean", "description": "Enable security authentication not responding to non-browser traffic.", "default": false }, "auth_user_agent": { "type": "array", "items": { "type": "string" }, "description": "The security authentication HTTP traffic with specified User-Agent." }, "access_profile_name": { "type": "string", "description": "Access profile name" } }, "description": "Contains authentication attributes", "example": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "CFNotificationOptions": { "title": "CFNotificationOptions", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "$ref": "#/components/schemas/CFNotificationOptionsCFNotificationType" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } }, "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } }, "CFProfileOptions": { "title": "CFProfileOptions", "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CFProfileOptionsCFDirection" }, "action": { "$ref": "#/components/schemas/CFProfileOptionsCFAction" } }, "example": { "direction": "DOWNLOAD", "action": "NO_ACTION" } }, "ContentFilteringProfile": { "title": "ContentFilteringProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Name of the content-filtering-profile object" }, "description": { "type": "string", "description": "Description of the content filtering profile object" }, "permit_command_list": { "type": "array", "items": { "type": "string" }, "description": "Permit command list" }, "block_content_type_list": { "type": "array", "items": { "type": "string" }, "description": "Types of harmful HTTP content you want to block that the MIME type or file extension cannot control. Accepted values: ACTIVEX, EXE, JAVA_APPLET, HTTP_COOKIE, ZIP" }, "block_file_extension_list": { "type": "array", "items": { "type": "string" }, "description": "Block extension list" }, "block_command_list": { "type": "array", "items": { "type": "string" }, "description": "Block command list" }, "block_mime_list": { "type": "array", "items": { "type": "string" }, "description": "The special MIME types you wish to block over HTTP, FTP, SMTP, and POP3 connections. Use commas to separate each MIME type." }, "mime_permit_list": { "type": "array", "items": { "type": "string" }, "description": "The special MIME types you wish to permit over HTTP, FTP, SMTP, and POP3 connections. Use commas to separate each MIME type." }, "notification_options": { "allOf": [ { "$ref": "#/components/schemas/CFNotificationOptions" }, { "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ] } }, "example": { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } }, "ContentFilteringProfileInput": { "title": "ContentFilteringProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the content-filtering-profile object" }, "description": { "type": "string", "description": "Description of the content filtering profile object" }, "permit_command_list": { "type": "array", "items": { "type": "string" }, "description": "Permit command list" }, "block_content_type_list": { "type": "array", "items": { "type": "string" }, "description": "Types of harmful HTTP content you want to block that the MIME type or file extension cannot control. Accepted values: ACTIVEX, EXE, JAVA_APPLET, HTTP_COOKIE, ZIP" }, "block_file_extension_list": { "type": "array", "items": { "type": "string" }, "description": "Block extension list" }, "block_command_list": { "type": "array", "items": { "type": "string" }, "description": "Block command list" }, "block_mime_list": { "type": "array", "items": { "type": "string" }, "description": "The special MIME types you wish to block over HTTP, FTP, SMTP, and POP3 connections. Use commas to separate each MIME type." }, "mime_permit_list": { "type": "array", "items": { "type": "string" }, "description": "The special MIME types you wish to permit over HTTP, FTP, SMTP, and POP3 connections. Use commas to separate each MIME type." }, "notification_options": { "allOf": [ { "$ref": "#/components/schemas/CFNotificationOptions" }, { "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ] } }, "example": { "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } }, "ContentSecurityProfile": { "title": "ContentSecurityProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the utm-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object" }, "anti_spam_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiSpamProfileRef2" }, "content_filtering_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfile2" }, "content_filtering_enhanced": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringEnhancedRef2" }, "anti_virus_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfile2" }, "web_filtering_profile": { "$ref": "#/components/schemas/ContentSecurityProfileWebFilteringProfileRef2" } }, "description": "utm-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } }, "ContentSecurityProfileAntiSpamProfileRef": { "title": "ContentSecurityProfileAntiSpamProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to AntiSpamProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileAntiVirusProfile": { "title": "ContentSecurityProfileAntiVirusProfile", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileSmtpProfileRef" } }, "description": "Anti-virus profile configuration with protocol-specific scanning settings", "example": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } } }, "ContentSecurityProfileCFFTPDownloadProfileRef": { "title": "ContentSecurityProfileCFFTPDownloadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFFTPDownloadProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileCFFTPUploadProfileRef": { "title": "ContentSecurityProfileCFFTPUploadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFFTPUploadProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileCFHTTPProfileRef": { "title": "ContentSecurityProfileCFHTTPProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFHTTPProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileCFImapProfileRef": { "title": "ContentSecurityProfileCFImapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFImapProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileCFPop3ProfileRef": { "title": "ContentSecurityProfileCFPop3ProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFPop3Profile", "example": { "uuid": "string" } }, "ContentSecurityProfileCFSMTPProfileRef": { "title": "ContentSecurityProfileCFSMTPProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to CFSMTPProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileContentFilteringEnhancedRef": { "title": "ContentSecurityProfileContentFilteringEnhancedRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to ContentFilteringEnhanced", "example": { "uuid": "string" } }, "ContentSecurityProfileContentFilteringProfile": { "title": "ContentSecurityProfileContentFilteringProfile", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileSmtpProfileRef" } }, "description": "Content filtering profile configuration with protocol-specific filtering settings", "example": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } } }, "ContentSecurityProfileFTPDownloadProfileRef": { "title": "ContentSecurityProfileFTPDownloadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to FTPDownloadProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileFTPUploadProfileRef": { "title": "ContentSecurityProfileFTPUploadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to FTPUploadProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileHTTPProfileRef": { "title": "ContentSecurityProfileHTTPProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to HTTPProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileImapProfileRef": { "title": "ContentSecurityProfileImapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to ImapProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileInput": { "title": "ContentSecurityProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the utm-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object" }, "anti_spam_profile": { "$ref": "#/components/schemas/ContentSecurityProfileInputAntiSpamProfileRef" }, "content_filtering_profile": { "$ref": "#/components/schemas/ContentSecurityProfileInputContentFilteringProfile" }, "content_filtering_enhanced": { "$ref": "#/components/schemas/ContentSecurityProfileInputContentFilteringEnhancedRef" }, "anti_virus_profile": { "$ref": "#/components/schemas/ContentSecurityProfileInputAntiVirusProfile" }, "web_filtering_profile": { "$ref": "#/components/schemas/ContentSecurityProfileInputWebFilteringProfileRef" } }, "description": "utm-profile object", "example": { "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } }, "ContentSecurityProfilePop3ProfileRef": { "title": "ContentSecurityProfilePop3ProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to Pop3Profile", "example": { "uuid": "string" } }, "ContentSecurityProfileSMTPProfileRef": { "title": "ContentSecurityProfileSMTPProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to SMTPProfile", "example": { "uuid": "string" } }, "ContentSecurityProfileWebFilteringProfileRef": { "title": "ContentSecurityProfileWebFilteringProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to WebFilteringProfile", "example": { "uuid": "string" } }, "ContentSecuritySettings": { "title": "ContentSecuritySettings", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object", "readOnly": true }, "very_safe_level": { "type": "integer", "description": "Very-safe reputation level value", "format": "int32" }, "moderately_safe_level": { "type": "integer", "description": "Moderately-safe reputation level value", "format": "int32" }, "fairly_safe_level": { "type": "integer", "description": "Fairly-safe reputation level value", "format": "int32" }, "suspicious_level": { "type": "integer", "description": "Suspicious reputation level value", "format": "int32" }, "av_mime_allow_list": { "type": "array", "items": { "type": "string" }, "description": "Comma separated MIME types for AV white list. Enter two strings separated by a slash (/). First string must begin with an alphanumeric character and can contain underscores (_) and single dashes (-). Second string can be null or begin with an alphanumeric character and can contain single _, -, dots (.), and plus signs (+). Special characters cannot appear in succession." }, "av_mime_exception_allow_list": { "type": "array", "items": { "type": "string" }, "description": "Comma separated MIME types for AV exception white list. Enter two strings separated by a slash (/). First string must begin with an alphanumeric character and can contain underscores (_) and single dashes (-). Second string can be null or begin with an alphanumeric character and can contain single _, -, dots (.), and plus signs (+). Special characters cannot appear in succession." }, "as_pattern_block_list": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecuritySettingsAsPatternBlackListRef" }, "description": "Anti-spam pattern block list references" }, "as_pattern_allow_list": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecuritySettingsAsPatternWhiteListRef" }, "description": "Anti-spam pattern allow list references" }, "av_category_allow_list": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecuritySettingsAvCategoryWhiteListRef" }, "description": "Anti-virus category allow list references" }, "wf_category_block_list": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecuritySettingsWFCategoryBlackListRef" }, "description": "Web-filtering category block list references" }, "wf_category_allow_list": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecuritySettingsWFCategoryWhiteListRef" }, "description": "Web-filtering category allow list references" } }, "description": "Content Security Settings resource", "example": { "name": "string", "very_safe_level": 1, "moderately_safe_level": 1, "fairly_safe_level": 1, "suspicious_level": 1, "av_mime_allow_list": [ "string" ], "av_mime_exception_allow_list": [ "string" ], "as_pattern_block_list": [ { "uuid": "string" } ], "as_pattern_allow_list": [ { "uuid": "string" } ], "av_category_allow_list": [ { "uuid": "string" } ], "wf_category_block_list": [ { "uuid": "string" } ], "wf_category_allow_list": [ { "uuid": "string" } ] } }, "ContentSecuritySettingsAsPatternBlackListRef": { "title": "ContentSecuritySettingsAsPatternBlackListRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to AsPatternBlackList", "example": { "uuid": "string" } }, "ContentSecuritySettingsAsPatternWhiteListRef": { "title": "ContentSecuritySettingsAsPatternWhiteListRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to AsPatternWhiteList", "example": { "uuid": "string" } }, "ContentSecuritySettingsAvCategoryWhiteListRef": { "title": "ContentSecuritySettingsAvCategoryWhiteListRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to AvCategoryWhiteList", "example": { "uuid": "string" } }, "ContentSecuritySettingsWFCategoryBlackListRef": { "title": "ContentSecuritySettingsWFCategoryBlackListRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to WFCategoryBlackList", "example": { "uuid": "string" } }, "ContentSecuritySettingsWFCategoryWhiteListRef": { "title": "ContentSecuritySettingsWFCategoryWhiteListRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } }, "description": "Reference to WFCategoryWhiteList", "example": { "uuid": "string" } }, "CreateDeviceGlobalSettingsRequest": { "title": "CreateDeviceGlobalSettingsRequest", "required": [ "device_id" ], "type": "object", "properties": { "device_id": { "type": "string", "description": "UUID of the device" }, "description": { "type": "string", "description": "Description of the device global settings object" }, "utm_profile": { "$ref": "#/components/schemas/CreateDeviceGlobalSettingsRequestUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/CreateDeviceGlobalSettingsRequestIpsProfileRef" } }, "description": "Request to create device-specific global settings", "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } }, "DeviceGlobalSettings": { "title": "DeviceGlobalSettings", "required": [ "uuid", "device_id" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the device-global-settings object", "readOnly": true }, "description": { "type": "string", "description": "Description of the device-global-settings" }, "device_id": { "type": "string", "description": "UUID of the device this settings applies to" }, "utm_profile": { "$ref": "#/components/schemas/DeviceGlobalSettingsUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/DeviceGlobalSettingsIpsProfileRef" } }, "description": "Device-specific global settings. One per device, inherits from tenant's GlobalSettings.", "example": { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } }, "DeviceGlobalSettingsProfileRef": { "title": "DeviceGlobalSettingsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } }, "description": "Reference to a profile (UTM, IPS, etc.)", "example": { "uuid": "string" } }, "ECFNotificationOptions": { "title": "ECFNotificationOptions", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "$ref": "#/components/schemas/CFNotificationOptionsCFNotificationType" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } }, "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } }, "EnhancedContentFilteringProfile": { "title": "EnhancedContentFilteringProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Name of the content-filtering-profile object" }, "description": { "type": "string", "description": "Description of the content filtering profile object" } }, "example": { "uuid": "string", "name": "string", "description": "string" } }, "EnhancedContentFilteringProfileInput": { "title": "EnhancedContentFilteringProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the content-filtering-profile object" }, "description": { "type": "string", "description": "Description of the content filtering profile object" } }, "example": { "name": "string", "description": "string" } }, "EnhancedContentFilteringProfileRule": { "title": "EnhancedContentFilteringProfileRule", "required": [ "uuid", "name", "ruleset_name", "notification_options", "cf_rule_options", "file_types" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Name of the cf profile or rule object" }, "ruleset_name": { "type": "string", "description": "Name of the ruleset object" }, "notification_options": { "allOf": [ { "$ref": "#/components/schemas/ECFNotificationOptions" }, { "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ] }, "cf_rule_options": { "allOf": [ { "$ref": "#/components/schemas/CFProfileOptions" }, { "example": { "direction": "DOWNLOAD", "action": "NO_ACTION" } } ] }, "seclog": { "type": "boolean", "description": "Sec Log. Default is False", "default": false }, "file_types": { "type": "array", "items": { "type": "string" }, "description": "File types" } }, "example": { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } }, "EnhancedContentFilteringProfileRuleInput": { "title": "EnhancedContentFilteringProfileRuleInput", "required": [ "name", "ruleset_name", "notification_options", "cf_rule_options", "file_types" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the cf profile or rule object" }, "ruleset_name": { "type": "string", "description": "Name of the ruleset object" }, "notification_options": { "allOf": [ { "$ref": "#/components/schemas/ECFNotificationOptions" }, { "example": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ] }, "cf_rule_options": { "allOf": [ { "$ref": "#/components/schemas/CFProfileOptions" }, { "example": { "direction": "DOWNLOAD", "action": "NO_ACTION" } } ] }, "seclog": { "type": "boolean", "description": "Sec Log. Default is False", "default": false }, "file_types": { "type": "array", "items": { "type": "string" }, "description": "File types" } }, "example": { "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } }, "EnhancedContentFilteringProfileRuleSet": { "title": "EnhancedContentFilteringProfileRuleSet", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Name of the rule-set object" } }, "example": { "uuid": "string", "name": "string" } }, "EnhancedContentFilteringProfileRuleSetInput": { "title": "EnhancedContentFilteringProfileRuleSetInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the rule-set object" } }, "example": { "name": "string" } }, "FeedsList": { "title": "FeedsList", "type": "object", "properties": { "feeds": { "type": "array", "items": { "type": "string" }, "description": "list of feeds" }, "threat_score": { "allOf": [ { "$ref": "#/components/schemas/FeedsThreatScoreObject" }, { "example": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } }, "description": "The feeds for which you want to define specific actions", "example": { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } }, "FeedsThreatScoreObject": { "title": "FeedsThreatScoreObject", "type": "object", "properties": { "permit": { "allOf": [ { "$ref": "#/components/schemas/FeedsThreatScoreValMapping" }, { "example": { "start": "string", "end": "string" } } ] }, "log": { "allOf": [ { "$ref": "#/components/schemas/FeedsThreatScoreValMapping" }, { "example": { "start": "string", "end": "string" } } ] }, "block": { "allOf": [ { "$ref": "#/components/schemas/FeedsThreatScoreValMapping" }, { "example": { "start": "string", "end": "string" } } ] } }, "example": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } }, "FeedsThreatScoreValMapping": { "title": "FeedsThreatScoreValMapping", "type": "object", "properties": { "start": { "type": "string", "description": "threat level start value" }, "end": { "type": "string", "description": "threat level end value" } }, "example": { "start": "string", "end": "string" } }, "GlobalProfile": { "title": "GlobalProfile", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object" }, "aamw_profile": { "$ref": "#/components/schemas/GlobalProfileAamwProfileRef" }, "dynamic_application": { "$ref": "#/components/schemas/GlobalProfileDynamicApplicationRef" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/GlobalProfileFlowBasedAntivirusProfileRef" }, "icap_profile": { "$ref": "#/components/schemas/GlobalProfileIcapProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/GlobalProfileIpsProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/GlobalProfileSecintelProfileGroupRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/GlobalProfileSslProxyProfileRef" }, "swp_profile": { "$ref": "#/components/schemas/GlobalProfileSwpProfileRef" }, "utm_profile": { "$ref": "#/components/schemas/GlobalProfileUtmProfileRef" } }, "description": "Global profile for a tenant", "example": { "name": "string", "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } }, "GlobalProfileRef": { "title": "GlobalProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } }, "description": "Reference to a profile", "example": { "uuid": "string", "name": "string" } }, "GlobalSettings": { "title": "GlobalSettings", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the global settings object" }, "description": { "type": "string", "description": "Description of the global settings object" }, "utm_profile": { "$ref": "#/components/schemas/GlobalSettingsUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/GlobalSettingsIpsProfileRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/GlobalSettingsSslProxyProfileRef" }, "aamw_profile": { "$ref": "#/components/schemas/GlobalSettingsAamwProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/GlobalSettingsSecintelProfileGroupRef" } }, "description": "Global settings for a tenant (singleton object)", "example": { "name": "string", "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } }, "GlobalSettingsProfileRef": { "title": "GlobalSettingsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } }, "description": "Reference to a profile", "example": { "uuid": "string", "name": "string" } }, "HttpProtocol": { "title": "HttpProtocol", "required": [ "inspection_profile", "action", "unknown_verdict_action" ], "type": "object", "properties": { "inspection_profile": { "type": "string", "description": "Name of the inspection profile to apply, e.g. default_profile" }, "action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "unknown_verdict_action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "client_notify": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolClientNotifyType" }, { "example": "CLIENT_NOTIFY_UNSPECIFIED" } ] }, "redirect_url": { "type": "string", "description": "URL to redirect the client to when client_notify is redirect-url. Required if client_notify is redirect-url" }, "message": { "type": "string", "description": "Custom notification message displayed to the client when client_notify is message. Required if client_notify is message" }, "file_name": { "type": "string", "description": "Name of the file associated with the inspection entry" }, "file_content": { "type": "string", "description": "Content of the file associated with the inspection entry" }, "files_meet_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files that meet or exceed the verdict threshold", "default": false } }, "description": "Advanced antimalware HTTP protocol inspection settings", "example": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true } }, "IPSExemptRule": { "title": "IPSExemptRule", "required": [ "uuid", "name", "ips_signature" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureReference" }, "description": "IPS signature references" }, "position": { "type": "integer", "description": "Position of rule in the parent rule group. Position starts from 0", "format": "int64" } }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } }, "IPSExemptRuleInput": { "title": "IPSExemptRuleInput", "required": [ "name", "ips_signature" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureReference" }, "description": "IPS signature references" }, "position": { "type": "integer", "description": "Position of rule in the parent rule group. Position starts from 0", "format": "int64" } }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } }, "IPSRule": { "title": "IPSRule", "required": [ "uuid", "name", "ips_signature", "then" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided", "readOnly": true }, "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureReference" }, "description": "IPS signature references" }, "then": { "allOf": [ { "$ref": "#/components/schemas/ThenOptions" }, { "example": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" } } ] }, "terminal": { "type": "boolean", "description": "Terminal", "default": false }, "position": { "type": "integer", "description": "Position of rule in the parent rule group. Position starts from 0", "format": "int64" }, "disabled": { "type": "boolean", "description": "Disabled", "default": false } }, "example": { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } }, "IPSRuleInput": { "title": "IPSRuleInput", "required": [ "name", "ips_signature", "then" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureReference" }, "description": "IPS signature references" }, "then": { "allOf": [ { "$ref": "#/components/schemas/ThenOptions" }, { "example": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" } } ] }, "terminal": { "type": "boolean", "description": "Terminal", "default": false }, "position": { "type": "integer", "description": "Position of rule in the parent rule group. Position starts from 0", "format": "int64" }, "disabled": { "type": "boolean", "description": "Disabled", "default": false } }, "example": { "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } }, "InfraNetOptions": { "title": "InfraNetOptions", "type": "object", "properties": { "redirect_url": { "type": "string", "description": "A URL for the webpage to which the client is directed. For example: http://www.juniper.net." }, "infranet_redirect": { "type": "string", "description": "Options of redirect. None if you do not want to redirect any traffic; All Traffic to redirect the encrypted traffic; Unauthenticated Traffic to redirect the unencrypted traffic. Allowed values: [REDIRECT_ALL, REDIRECT_UNAUTHENTICATED]" } }, "description": "Specify options related to infranet authentication type", "example": { "redirect_url": "string", "infranet_redirect": "string" } }, "IpsProfile": { "title": "IpsProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object. Format: ^[^#&;\\r\\n ]{1,127}$" }, "description": { "type": "string", "description": "Description of the object" } }, "example": { "uuid": "string", "name": "string", "description": "string" } }, "ListAamwProfileResponse": { "title": "ListAamwProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AamwProfile" }, "description": "List of aamw profiles" }, "count": { "type": "string", "description": "Total count of aamw profiles" } }, "description": "Response containing a list of aamw profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "http_protocol": { "inspection_profile": "string", "action": "MALWARE_ACTION_UNSPECIFIED", "unknown_verdict_action": "MALWARE_ACTION_UNSPECIFIED", "client_notify": "CLIENT_NOTIFY_UNSPECIFIED", "redirect_url": "string", "message": "string", "file_name": "string", "file_content": "string", "files_meet_verdict_threshold": true }, "additional_logging": { "files_below_verdict_threshold": true, "blocklist": true, "allowlist": true }, "smtp_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "smb_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "imap_protocol": [ { "inspection_profile": "string", "notification": "string", "action": "string" } ], "fallback_options": [ { "action": "string", "notification": "string", "service_not_ready_action": "string", "service_not_ready_notification": "string", "invalid_content_size_action": "string", "invalid_content_size_notification": "string", "out_of_resources_action": "string", "out_of_resources_notification": "string", "verdict_timeout_action": "string", "verdict_timeout_notification": "string", "submission_timeout_action": "string", "submission_timeout_notification": "string", "unknown_file_action": "string", "unknown_file_notification": "string" } ] } ], "count": "string" } }, "ListAnomalyTestsResponse": { "title": "ListAnomalyTestsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of anomaly test names" }, "count": { "type": "integer", "description": "Total number of anomaly tests", "format": "int32" } }, "example": { "items": [ "string" ], "count": 1 } }, "ListContentFilteringProfileResponse": { "title": "ListContentFilteringProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContentFilteringProfile" }, "description": "List of resources matching the query criteria" }, "count": { "type": "string", "description": "Total number of resources matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "permit_command_list": [ "string" ], "block_content_type_list": [ "string" ], "block_file_extension_list": [ "string" ], "block_command_list": [ "string" ], "block_mime_list": [ "string" ], "mime_permit_list": [ "string" ], "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true } } ], "count": "string" } }, "ListContentSecurityProfileResponse": { "title": "ListContentSecurityProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContentSecurityProfile" }, "description": "List of content security profile profiles" }, "count": { "type": "string", "description": "Total count of content security profile profiles" } }, "description": "Response containing a list of content security profile profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "anti_spam_profile": { "uuid": "string" }, "content_filtering_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "content_filtering_enhanced": { "uuid": "string" }, "anti_virus_profile": { "ftp_download_profile": { "uuid": "string" }, "ftp_upload_profile": { "uuid": "string" }, "http_profile": { "uuid": "string" }, "imap_profile": { "uuid": "string" }, "pop3_profile": { "uuid": "string" }, "smtp_profile": { "uuid": "string" } }, "web_filtering_profile": { "uuid": "string" } } ], "count": "string" } }, "ListDeviceGlobalSettingsResponse": { "title": "ListDeviceGlobalSettingsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceGlobalSettings" }, "description": "List of device global settings" }, "count": { "type": "string", "description": "Total count of device global settings" } }, "example": { "items": [ { "uuid": "string", "description": "string", "device_id": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } ], "count": "string" } }, "ListEnhancedContentFilteringProfileResponse": { "title": "ListEnhancedContentFilteringProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedContentFilteringProfile" }, "description": "List of resources matching the query criteria" }, "count": { "type": "string", "description": "Total number of resources matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } }, "ListEnhancedContentFilteringProfileRuleResponse": { "title": "ListEnhancedContentFilteringProfileRuleResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRule" }, "description": "List of rules matching the query criteria" }, "count": { "type": "string", "description": "Total number of rules matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string", "ruleset_name": "string", "notification_options": { "custom_notification_message": "string", "notification_type": "PROTOCOL", "notify_mail_sender": true }, "cf_rule_options": { "direction": "DOWNLOAD", "action": "NO_ACTION" }, "seclog": true, "file_types": [ "string" ] } ], "count": "string" } }, "ListEnhancedContentFilteringProfileRuleSetResponse": { "title": "ListEnhancedContentFilteringProfileRuleSetResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnhancedContentFilteringProfileRuleSet" }, "description": "List of rule-sets matching the query criteria" }, "count": { "type": "string", "description": "Total number of rule-sets matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string" } ], "count": "string" } }, "ListIPSExemptRuleResponse": { "title": "ListIPSExemptRuleResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IPSExemptRule" }, "description": "List of IPS exempt rules matching the query criteria" }, "count": { "type": "string", "description": "Total number of IPS exempt rules matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "position": 1 } ], "count": "string" } }, "ListIPSRuleResponse": { "title": "ListIPSRuleResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IPSRule" }, "description": "List of IPS rules matching the query criteria" }, "count": { "type": "string", "description": "Total number of IPS rules matching the query criteria" } }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ips_signature": [ { "uuid": "string", "name": "string" } ], "then": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" }, "terminal": true, "position": 1, "disabled": true } ], "count": "string" } }, "ListIpsProfileResponse": { "title": "ListIpsProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IpsProfile" }, "description": "List of IPS profiles" }, "count": { "type": "string", "description": "Total count of IPS profiles" } }, "description": "Response containing a list of IPS profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string" } ], "count": "string" } }, "ListRuleOptionResponse": { "title": "ListRuleOptionResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RuleOption" }, "description": "List of rule options" }, "count": { "type": "string", "description": "Total count of rule options" } }, "description": "Response containing a list of rule options" }, "ListSSLProxyProfileResponse": { "title": "ListSSLProxyProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SSLProxyProfile" }, "description": "List of sslproxy profiles" }, "count": { "type": "string", "description": "Total count of sslproxy profiles" } }, "description": "Response containing a list of sslproxy profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListSecIntelProfileResponse": { "title": "ListSecIntelProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfile" }, "description": "List of SecIntel profiles" }, "count": { "type": "string", "description": "Total count of SecIntel profiles" } }, "description": "Response containing a list of SecIntel profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } ], "count": "string" } }, "ListSignatureCategoriesResponse": { "title": "ListSignatureCategoriesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "List of signature category names, sorted alphabetically" }, "count": { "type": "integer", "description": "Total number of signature categories", "format": "int32" } }, "example": { "items": [ "string" ], "count": 1 } }, "ListWebFilteringProfileResponse": { "title": "ListWebFilteringProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebFilteringProfile" }, "description": "List of web filtering profiles" }, "count": { "type": "string", "description": "Total count of web filtering profiles" } }, "description": "Response containing a list of web filtering profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } ], "count": "string" } }, "ObjectReference": { "title": "ObjectReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "uuid" }, "name": { "type": "string", "description": "name" } }, "description": "List of Root-CA and trusted CAs mapping to devices", "example": { "uuid": "string", "name": "string" } }, "PassThroughOptions": { "title": "PassThroughOptions", "type": "object", "properties": { "web_auth_client_name": { "type": "array", "items": { "type": "string" }, "description": "The names of the users or user groups in a profile for whom this policy allows access. If you do not specify any users or user groups, any user who is successfully authenticated." }, "authentication_attributes": { "$ref": "#/components/schemas/PassThroughOptionsAuthenticationAttributes" } }, "description": "Specify options related to pass through authentication type", "example": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } } }, "RuleOption": { "title": "RuleOption", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object" }, "authentication": { "$ref": "#/components/schemas/RuleOptionAuthentication" }, "advanced_settings": { "$ref": "#/components/schemas/RuleOptionAdvancedSettings" } }, "description": "machine identity object details", "example": { "uuid": "string", "name": "string", "description": "string", "authentication": { "authentication_type": "string", "push_to_jims": true, "pass_through_options": { "web_auth_client_name": [ "string" ], "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "web_options": [ "string" ], "userfw_options": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } }, "infranet_options": { "redirect_url": "string", "infranet_redirect": "string" } }, "advanced_settings": { "service_offload": true, "destination_address_translation": "string", "redirect": "string", "tcp_syn_check": true, "tcp_seq_check": true, "windows_scale_check": true, "initial_tcp_mss": "string", "reverse_tcp_mss": "string", "captive_portal_name": "string" } } }, "SSLForwardProxyCertificates": { "title": "SSLForwardProxyCertificates", "required": [ "root_certificate" ], "type": "object", "properties": { "device": { "$ref": "#/components/schemas/SSLForwardProxyCertificatesDevice" }, "root_certificate": { "$ref": "#/components/schemas/SSLForwardProxyCertificatesRootCertificate" }, "trusted_ca": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "List of trusted certificate authority profiles. Max length: 100000" } }, "description": "List of Root-CA and trusted CAs mapping to devices", "example": { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } }, "SSLProxyProfile": { "title": "SSLProxyProfile", "required": [ "uuid", "certificates" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "ssl_type": { "type": "string", "description": "SSL proxy profile type. Allowed values: [REVERSE, FORWARD]", "default": "FORWARD" }, "preferred_cipher": { "type": "string", "description": "Preferred cipher associated with the profile.. Allowed values: [none, custom, medium, strong, weak]" }, "custom_cipher": { "type": "array", "items": { "type": "string" }, "description": "The set of ciphers, if the preferred cipher is Custom, which the SSH server uses to perform the encryption and the decryption functions." }, "enable_flow_tracing": { "type": "boolean", "description": "Enable flow tracing for troubleshooting policy-related issues.", "default": false }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/SSLForwardProxyCertificates" }, "description": "Root certificate for interdicting server certificates in proxy mode and List of trusted certificate authority profiles. Root certificate is mandatory.. Min length: 1. Max length: 100000" }, "ignore_server_auth_failure": { "type": "boolean", "description": "To ignore errors encountered during the server certificate verification process (such as CA signature verification failure, self-signed certificates, and certificate expiry).", "default": false }, "disable_session_resumption": { "type": "boolean", "description": "Disable session resumption", "default": false }, "all_log": { "type": "boolean", "description": "Log all events", "default": false }, "info_log": { "type": "boolean", "description": "Log all information events", "default": false }, "warning_log": { "type": "boolean", "description": "Log all warning events", "default": false }, "error_log": { "type": "boolean", "description": "Log all error events", "default": false }, "session_ignored_log": { "type": "boolean", "description": "Log session ignore events", "default": false }, "sessions_allowed_log": { "type": "boolean", "description": "Log ssl session allow events after an error", "default": false }, "sessions_dropped_log": { "type": "boolean", "description": "Log only ssl session drop events", "default": false }, "sessions_white_listed_log": { "type": "boolean", "description": "Log ssl session whitelist events", "default": false }, "renegotiation": { "type": "string", "description": "Indicates the type of renegotiation required for a change in SSL parameters after creating a session and establishing the SSL tunnel transport.. Allowed values: [ALLOW_SECURE, DROP, ALLOW, NONE]" }, "exempted_address": { "type": "array", "items": { "$ref": "#/components/schemas/SSLProxyProfileExemptedAddressRef" }, "description": "Exempted addresses referred in ssl-proxy-profile" }, "whitelist_url_category": { "type": "array", "items": { "$ref": "#/components/schemas/SSLProxyProfileWhitelistURLCategoryRef" }, "description": "Exempted url-category-list referred in ssl-proxy-profile" } }, "description": "SSL Forward proxy profile object", "example": { "uuid": "string", "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } }, "SSLProxyProfileExemptedAddressRef": { "title": "SSLProxyProfileExemptedAddressRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to ExemptedAddress", "example": { "uuid": "string" } }, "SSLProxyProfileWhitelistURLCategoryRef": { "title": "SSLProxyProfileWhitelistURLCategoryRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to WhitelistURLCategory", "example": { "uuid": "string" } }, "SecintelProfile": { "title": "SecintelProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the secintel profile object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "feed_category": { "type": "string", "description": "Allowed values: [CC, DNS, Infected-Hosts]" }, "block_action": { "type": "string", "description": "The action to be taken for the blocked feeds.. Allowed values: [close, drop, sinkhole]" }, "close_session_action": { "type": "string", "description": "The action to be taken for the blocked feeds when the action is to close session.. Allowed values: [file, message, redirect-url]" }, "redirect_url": { "type": "string", "description": "HTTP URL redirection for a customized client notification based on detected malware with the block action." }, "redirect_msg": { "type": "string", "description": "The message for a customized client notification based on detected malware with the block action. Range: 1 through 1023" }, "uploaded_file_name": { "type": "string", "description": "name of the file uploaded by user" }, "uploaded_file_content": { "type": "string", "description": "content of the file uploaded by user" }, "default_feeds_action": { "type": "array", "items": { "$ref": "#/components/schemas/FeedsList" }, "description": "stores the default threat score for all the feeds.For example, permit if the score is between 1-4, Log if the score is between 5-6, Block if the score is between 7-10." }, "specific_feeds_action": { "type": "array", "items": { "$ref": "#/components/schemas/FeedsList" }, "description": "stores the user configured threat scores for specific feeds. For example, you can change the action based on the threat scores for individual feeds." } }, "description": "secintel-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } }, "SignatureReference": { "title": "SignatureReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the IPS signature" }, "name": { "type": "string", "description": "Name of the IPS signature" } }, "example": { "uuid": "string", "name": "string" } }, "ThenOptions": { "title": "ThenOptions", "type": "object", "properties": { "action": { "type": "string", "description": "Action choices" }, "dscp_code": { "type": "string", "description": "DSCP code" }, "ip_action": { "type": "string", "description": "IP action" }, "timeout": { "type": "integer", "description": "Timeout", "format": "int32" }, "target": { "type": "string", "description": "Target" }, "log": { "type": "boolean", "description": "Log", "default": false }, "log_create": { "type": "boolean", "description": "Log create", "default": false }, "refresh_timeout": { "type": "boolean", "description": "Refresh timeout", "default": false }, "log_attacks": { "type": "boolean", "description": "Log attacks", "default": false }, "alert": { "type": "boolean", "description": "Alert", "default": false }, "packet_log": { "type": "boolean", "description": "Packet log", "default": false }, "pre_attack": { "type": "integer", "description": "Pre attack", "format": "int32" }, "post_attack": { "type": "integer", "description": "Post attack", "format": "int32" }, "post_attack_timeout": { "type": "integer", "description": "Post attack timeout", "format": "int32" }, "severity": { "type": "string", "description": "Severity" } }, "example": { "action": "string", "dscp_code": "string", "ip_action": "string", "timeout": 1, "target": "string", "log": true, "log_create": true, "refresh_timeout": true, "log_attacks": true, "alert": true, "packet_log": true, "pre_attack": 1, "post_attack": 1, "post_attack_timeout": 1, "severity": "string" } }, "UpdateGlobalProfileRequest": { "title": "UpdateGlobalProfileRequest", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the global profile object" }, "aamw_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestAamwProfileRef" }, "dynamic_application": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestDynamicApplicationRef" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestFlowBasedAntivirusProfileRef" }, "icap_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestIcapProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestIpsProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSecintelProfileGroupRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSslProxyProfileRef" }, "swp_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSwpProfileRef" }, "utm_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestUtmProfileRef" } }, "description": "Request to update a global profile. Note: Name cannot be modified as GlobalProfile is a singleton per tenant.", "example": { "description": "string", "aamw_profile": { "uuid": "string", "name": "string" }, "dynamic_application": { "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "uuid": "string", "name": "string" }, "icap_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "swp_profile": { "uuid": "string", "name": "string" }, "utm_profile": { "uuid": "string", "name": "string" } } }, "UpdateGlobalSettingsRequest": { "title": "UpdateGlobalSettingsRequest", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the global settings object" }, "utm_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestIpsProfileRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestSslProxyProfileRef" }, "aamw_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestAamwProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestSecintelProfileGroupRef" } }, "description": "Request to update global settings. Note: Name cannot be modified as GlobalSettings is a singleton per tenant.", "example": { "description": "string", "utm_profile": { "uuid": "string", "name": "string" }, "ips_profile": { "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "uuid": "string", "name": "string" }, "aamw_profile": { "uuid": "string", "name": "string" }, "secintel_profile_group": { "uuid": "string", "name": "string" } } }, "UserFWOptions": { "title": "UserFWOptions", "type": "object", "properties": { "user_firewall_domain": { "type": "string", "description": "user firewall domain" }, "authentication_attributes": { "$ref": "#/components/schemas/UserFWOptionsAuthenticationAttributes" } }, "description": "Specify options related to User Firewall authentication type", "example": { "user_firewall_domain": "string", "authentication_attributes": { "web_redirect": true, "web_redirect_to_https": true, "web_authentication_server": "string", "ssl_termination_profile": "string", "auth_only_browser": true, "auth_user_agent": [ "string" ], "access_profile_name": "string" } } }, "WFCategoryActionMapping": { "title": "WFCategoryActionMapping", "type": "object", "properties": { "category_uuid": { "type": "string", "description": "uuid of the category reference" }, "category_name": { "type": "string", "description": "name of the category" }, "action": { "type": "string", "description": "Action choice. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE]" }, "custom_message": { "type": "string", "description": "Custom message" }, "redirect_profile_id": { "type": "string", "description": "redirect profile id" }, "redirect_type": { "type": "string", "description": "redirect profile type" } }, "description": "List of category-list and the action to be taken.", "example": { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } }, "WFFallbackSettings": { "title": "WFFallbackSettings", "type": "object", "properties": { "default": { "type": "string", "description": "Fallback default settings. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "server_connectivity": { "type": "string", "description": "Fallback action when device cannot connect to server. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "timeout": { "type": "string", "description": "Fallback action when connection to server timeout. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "too_many_requests": { "type": "string", "description": "Fallback action when requests exceed the limit of engine. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" } }, "description": "Web filtering profile fallback settings", "example": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } }, "WFSiteReputationAction": { "title": "WFSiteReputationAction", "type": "object", "properties": { "moderately_safe": { "type": "string", "description": "Action when site reputation is moderately safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "harmful": { "type": "string", "description": "Action when site reputation is harmful. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "suspicious": { "type": "string", "description": "Action when site reputation is suspicious. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "very_safe": { "type": "string", "description": "Action when site reputation is very safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "fairly_safe": { "type": "string", "description": "Action when site reputation is fairly safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" } }, "description": "Web-filtering profile's virus-detection notification options", "example": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" } }, "WebFilteringProfile": { "title": "WebFilteringProfile", "required": [ "uuid", "name", "profile_type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the web-filtering-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "profile_type": { "type": "string", "description": "Web filtering profile type. Allowed values: [WEBSENSE, LOCAL, JUNIPER_ENHANCED, NG_JUNIPER]" }, "port": { "type": "integer", "description": "Server port (1024..65535)", "format": "int32" }, "server": { "type": "string", "description": "Server host IP address or string host name" }, "account": { "type": "string", "description": "Websense redirect account" }, "timeout": { "type": "integer", "description": "Websense redirect timeout (1..1800 seconds)", "format": "int32" }, "sockets": { "type": "integer", "description": "Websense redirect sockets number (1..32)", "format": "int32" }, "safe_search": { "type": "boolean", "description": "perform safe-search for Juniper enhanced protocol", "default": false }, "default_action": { "type": "string", "description": "Default action. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "custom_block_message": { "type": "string", "description": "Juniper enhanced custom block message sent to HTTP client" }, "quarantine_custom_message": { "type": "string", "description": "Juniper enhanced quarantine custom message" }, "site_reputation_actions": { "$ref": "#/components/schemas/WebFilteringProfileSiteReputationActions" }, "url_category_action_list": { "type": "array", "items": { "$ref": "#/components/schemas/WFCategoryActionMapping" }, "description": "Category action mapping. List of category-list and the action to be taken." }, "fallback_settings": { "$ref": "#/components/schemas/WebFilteringProfileFallbackSettings" } }, "description": "web-filtering-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } }, "UpdateDeviceGlobalSettingsRequest": { "title": "UpdateDeviceGlobalSettingsRequest", "type": "object", "properties": { "device_id": { "type": "string", "description": "UUID of the device" }, "description": { "type": "string", "description": "Description of the device global settings object" }, "utm_profile": { "$ref": "#/components/schemas/UpdateDeviceGlobalSettingsRequestUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/UpdateDeviceGlobalSettingsRequestIpsProfileRef" } }, "description": "Request to update device-specific global settings", "example": { "device_id": "string", "description": "string", "utm_profile": { "uuid": "string" }, "ips_profile": { "uuid": "string" } } }, "AamwProfileAdditionalLogging": { "title": "AamwProfileAdditionalLogging", "type": "object", "properties": { "files_below_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files below the verdict threshold", "default": false }, "blocklist": { "type": "boolean", "description": "When true, enables logging of block list hits", "default": false }, "allowlist": { "type": "boolean", "description": "When true, enables logging of allow list hits", "default": false } } }, "AamwProfileHttpProtocol": { "title": "AamwProfileHttpProtocol", "required": [ "inspection_profile", "action", "unknown_verdict_action" ], "type": "object", "properties": { "inspection_profile": { "type": "string", "description": "Name of the inspection profile to apply, e.g. default_profile" }, "action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "unknown_verdict_action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "client_notify": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolClientNotifyType" }, { "example": "CLIENT_NOTIFY_UNSPECIFIED" } ] }, "redirect_url": { "type": "string", "description": "URL to redirect the client to when client_notify is redirect-url. Required if client_notify is redirect-url" }, "message": { "type": "string", "description": "Custom notification message displayed to the client when client_notify is message. Required if client_notify is message" }, "file_name": { "type": "string", "description": "Name of the file associated with the inspection entry" }, "file_content": { "type": "string", "description": "Content of the file associated with the inspection entry" }, "files_meet_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files that meet or exceed the verdict threshold", "default": false } } }, "AamwProfileInputAdditionalLogging": { "title": "AamwProfileInputAdditionalLogging", "type": "object", "properties": { "files_below_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files below the verdict threshold", "default": false }, "blocklist": { "type": "boolean", "description": "When true, enables logging of block list hits", "default": false }, "allowlist": { "type": "boolean", "description": "When true, enables logging of allow list hits", "default": false } } }, "AamwProfileInputHttpProtocol": { "title": "AamwProfileInputHttpProtocol", "required": [ "inspection_profile", "action", "unknown_verdict_action" ], "type": "object", "properties": { "inspection_profile": { "type": "string", "description": "Name of the inspection profile to apply, e.g. default_profile" }, "action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "unknown_verdict_action": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolMalwareAction" }, { "example": "MALWARE_ACTION_UNSPECIFIED" } ] }, "client_notify": { "allOf": [ { "$ref": "#/components/schemas/HttpProtocolClientNotifyType" }, { "example": "CLIENT_NOTIFY_UNSPECIFIED" } ] }, "redirect_url": { "type": "string", "description": "URL to redirect the client to when client_notify is redirect-url. Required if client_notify is redirect-url" }, "message": { "type": "string", "description": "Custom notification message displayed to the client when client_notify is message. Required if client_notify is message" }, "file_name": { "type": "string", "description": "Name of the file associated with the inspection entry" }, "file_content": { "type": "string", "description": "Content of the file associated with the inspection entry" }, "files_meet_verdict_threshold": { "type": "boolean", "description": "When true, enables logging of files that meet or exceed the verdict threshold", "default": false } } }, "ApiV1FirewallDeviceGlobalSettingsRequest": { "title": "ApiV1FirewallDeviceGlobalSettingsRequest", "required": [ "device_id" ], "type": "object", "properties": { "device_id": { "type": "string", "description": "UUID of the device" }, "description": { "type": "string", "description": "Description of the device global settings object" }, "utm_profile": { "$ref": "#/components/schemas/CreateDeviceGlobalSettingsRequestUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/CreateDeviceGlobalSettingsRequestIpsProfileRef" } } }, "ApiV1FirewallGlobalProfilesRequest": { "title": "ApiV1FirewallGlobalProfilesRequest", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the global profile object" }, "aamw_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestAamwProfileRef" }, "dynamic_application": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestDynamicApplicationRef" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestFlowBasedAntivirusProfileRef" }, "icap_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestIcapProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestIpsProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSecintelProfileGroupRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSslProxyProfileRef" }, "swp_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestSwpProfileRef" }, "utm_profile": { "$ref": "#/components/schemas/UpdateGlobalProfileRequestUtmProfileRef" } } }, "ApiV1FirewallGlobalSettingsRequest": { "title": "ApiV1FirewallGlobalSettingsRequest", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the global settings object" }, "utm_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestUtmProfileRef" }, "ips_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestIpsProfileRef" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestSslProxyProfileRef" }, "aamw_profile": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestAamwProfileRef" }, "secintel_profile_group": { "$ref": "#/components/schemas/UpdateGlobalSettingsRequestSecintelProfileGroupRef" } } }, "AuthenticationInfranetOptions": { "title": "AuthenticationInfranetOptions", "type": "object", "properties": { "redirect_url": { "type": "string", "description": "A URL for the webpage to which the client is directed. For example: http://www.juniper.net." }, "infranet_redirect": { "type": "string", "description": "Options of redirect. None if you do not want to redirect any traffic; All Traffic to redirect the encrypted traffic; Unauthenticated Traffic to redirect the unencrypted traffic. Allowed values: [REDIRECT_ALL, REDIRECT_UNAUTHENTICATED]" } } }, "AuthenticationPassThroughOptions": { "title": "AuthenticationPassThroughOptions", "type": "object", "properties": { "web_auth_client_name": { "type": "array", "items": { "type": "string" }, "description": "The names of the users or user groups in a profile for whom this policy allows access. If you do not specify any users or user groups, any user who is successfully authenticated." }, "authentication_attributes": { "$ref": "#/components/schemas/PassThroughOptionsAuthenticationAttributes" } } }, "AuthenticationUserfwOptions": { "title": "AuthenticationUserfwOptions", "type": "object", "properties": { "user_firewall_domain": { "type": "string", "description": "user firewall domain" }, "authentication_attributes": { "$ref": "#/components/schemas/UserFWOptionsAuthenticationAttributes" } } }, "ContentSecurityProfileAntiSpamProfileRef2": { "title": "ContentSecurityProfileAntiSpamProfileRef2", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfile2": { "title": "ContentSecurityProfileAntiVirusProfile2", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileSmtpProfileRef" } } }, "ContentSecurityProfileAntiVirusProfileFtpDownloadProfileRef": { "title": "ContentSecurityProfileAntiVirusProfileFtpDownloadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfileFtpUploadProfileRef": { "title": "ContentSecurityProfileAntiVirusProfileFtpUploadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfileHttpProfileRef": { "title": "ContentSecurityProfileAntiVirusProfileHttpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfileImapProfileRef": { "title": "ContentSecurityProfileAntiVirusProfileImapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfilePop3ProfileRef": { "title": "ContentSecurityProfileAntiVirusProfilePop3ProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileAntiVirusProfileSmtpProfileRef": { "title": "ContentSecurityProfileAntiVirusProfileSmtpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringEnhancedRef2": { "title": "ContentSecurityProfileContentFilteringEnhancedRef2", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfile2": { "title": "ContentSecurityProfileContentFilteringProfile2", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileSmtpProfileRef" } } }, "ContentSecurityProfileContentFilteringProfileFtpDownloadProfileRef": { "title": "ContentSecurityProfileContentFilteringProfileFtpDownloadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfileFtpUploadProfileRef": { "title": "ContentSecurityProfileContentFilteringProfileFtpUploadProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfileHttpProfileRef": { "title": "ContentSecurityProfileContentFilteringProfileHttpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfileImapProfileRef": { "title": "ContentSecurityProfileContentFilteringProfileImapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfilePop3ProfileRef": { "title": "ContentSecurityProfileContentFilteringProfilePop3ProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileContentFilteringProfileSmtpProfileRef": { "title": "ContentSecurityProfileContentFilteringProfileSmtpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileInputAntiSpamProfileRef": { "title": "ContentSecurityProfileInputAntiSpamProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileInputAntiVirusProfile": { "title": "ContentSecurityProfileInputAntiVirusProfile", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileAntiVirusProfileSmtpProfileRef" } } }, "ContentSecurityProfileInputContentFilteringEnhancedRef": { "title": "ContentSecurityProfileInputContentFilteringEnhancedRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileInputContentFilteringProfile": { "title": "ContentSecurityProfileInputContentFilteringProfile", "type": "object", "properties": { "ftp_download_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpDownloadProfileRef" }, "ftp_upload_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileFtpUploadProfileRef" }, "http_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileHttpProfileRef" }, "imap_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileImapProfileRef" }, "pop3_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfilePop3ProfileRef" }, "smtp_profile": { "$ref": "#/components/schemas/ContentSecurityProfileContentFilteringProfileSmtpProfileRef" } } }, "ContentSecurityProfileInputWebFilteringProfileRef": { "title": "ContentSecurityProfileInputWebFilteringProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "ContentSecurityProfileWebFilteringProfileRef2": { "title": "ContentSecurityProfileWebFilteringProfileRef2", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object" } } }, "CreateDeviceGlobalSettingsRequestIpsProfileRef": { "title": "CreateDeviceGlobalSettingsRequestIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "CreateDeviceGlobalSettingsRequestUtmProfileRef": { "title": "CreateDeviceGlobalSettingsRequestUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "DeviceGlobalSettingsIpsProfileRef": { "title": "DeviceGlobalSettingsIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "DeviceGlobalSettingsUtmProfileRef": { "title": "DeviceGlobalSettingsUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "GlobalProfileAamwProfileRef": { "title": "GlobalProfileAamwProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileDynamicApplicationRef": { "title": "GlobalProfileDynamicApplicationRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileFlowBasedAntivirusProfileRef": { "title": "GlobalProfileFlowBasedAntivirusProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileIcapProfileRef": { "title": "GlobalProfileIcapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileIpsProfileRef": { "title": "GlobalProfileIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileSecintelProfileGroupRef": { "title": "GlobalProfileSecintelProfileGroupRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileSslProxyProfileRef": { "title": "GlobalProfileSslProxyProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileSwpProfileRef": { "title": "GlobalProfileSwpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalProfileUtmProfileRef": { "title": "GlobalProfileUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "GlobalSettingsAamwProfileRef": { "title": "GlobalSettingsAamwProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "GlobalSettingsIpsProfileRef": { "title": "GlobalSettingsIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "GlobalSettingsSecintelProfileGroupRef": { "title": "GlobalSettingsSecintelProfileGroupRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "GlobalSettingsSslProxyProfileRef": { "title": "GlobalSettingsSslProxyProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "GlobalSettingsUtmProfileRef": { "title": "GlobalSettingsUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "PassThroughOptionsAuthenticationAttributes": { "title": "PassThroughOptionsAuthenticationAttributes", "type": "object", "properties": { "web_redirect": { "type": "boolean", "description": "Web redirect", "default": false }, "web_redirect_to_https": { "type": "boolean", "description": "Web redirect to https", "default": false }, "web_authentication_server": { "type": "string", "description": "Firewall Web authentication server" }, "ssl_termination_profile": { "type": "string", "description": "Specify SSL termination profileused to the SSL offload" }, "auth_only_browser": { "type": "boolean", "description": "Enable security authentication not responding to non-browser traffic.", "default": false }, "auth_user_agent": { "type": "array", "items": { "type": "string" }, "description": "The security authentication HTTP traffic with specified User-Agent." }, "access_profile_name": { "type": "string", "description": "Access profile name" } } }, "RuleOptionAdvancedSettings": { "title": "RuleOptionAdvancedSettings", "type": "object", "properties": { "service_offload": { "type": "boolean", "description": "Service Offload", "default": false }, "destination_address_translation": { "type": "string", "description": "Destination Address Translation. Allowed values: [DROP_TRANSLATED, DROP_UNTRANSLATED]" }, "redirect": { "type": "string", "description": "Application-services - WX redirection. Allowed values: [REDIRECT_WX, REVERSE_REDIRECT_WX]" }, "tcp_syn_check": { "type": "boolean", "description": "Reject TCP segments with non-SYN flags that do not belong to an established session", "default": false }, "tcp_seq_check": { "type": "boolean", "description": "Enable to monitor the TCP byte sequence counter and to validate the trusted acknowledgment number against the untrusted sequence number.", "default": false }, "windows_scale_check": { "type": "boolean", "description": "Enable to increase the network transmission speed.", "default": false }, "initial_tcp_mss": { "type": "string", "description": "The TCP maximum segment size (MSS) for packets arriving at the ingress interface (initial direction). If the value in the packet is higher than the one you provide, the configured value overrides the TCP MSS value in the incoming packet. The range is 64 through 65535." }, "reverse_tcp_mss": { "type": "string", "description": "The TCP maximum segment size (MSS) for packets that match a specific policy and travel in the reverse direction of a session. If the value in the packet is higher than the one you select, the configured value replaces the TCP MSS value. The range is 64 through 65535" }, "captive_portal_name": { "type": "string", "description": "Captive Portal Name during Config Import" } } }, "RuleOptionAuthentication": { "title": "RuleOptionAuthentication", "type": "object", "properties": { "authentication_type": { "type": "string", "description": "Type of firewall authentication. Allowed values: [NONE, PASSTHROUGH, WEB_AUTHENTICATION, USER_FIREWALL, INFRANET_AUTHENTICATION]" }, "push_to_jims": { "type": "boolean", "description": "Push to JIMS", "default": false }, "pass_through_options": { "$ref": "#/components/schemas/AuthenticationPassThroughOptions" }, "web_options": { "type": "array", "items": { "type": "string" }, "description": "Specify the options related to web authentication type" }, "userfw_options": { "$ref": "#/components/schemas/AuthenticationUserfwOptions" }, "infranet_options": { "$ref": "#/components/schemas/AuthenticationInfranetOptions" } } }, "SSLForwardProxyCertificatesDevice": { "title": "SSLForwardProxyCertificatesDevice", "type": "object", "properties": { "uuid": { "type": "string", "description": "uuid" }, "name": { "type": "string", "description": "name" } } }, "SSLForwardProxyCertificatesRootCertificate": { "title": "SSLForwardProxyCertificatesRootCertificate", "type": "object", "properties": { "uuid": { "type": "string", "description": "uuid" }, "name": { "type": "string", "description": "name" } } }, "UpdateDeviceGlobalSettingsRequestIpsProfileRef": { "title": "UpdateDeviceGlobalSettingsRequestIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "UpdateDeviceGlobalSettingsRequestUtmProfileRef": { "title": "UpdateDeviceGlobalSettingsRequestUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the profile" } } }, "UpdateGlobalProfileRequestAamwProfileRef": { "title": "UpdateGlobalProfileRequestAamwProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestDynamicApplicationRef": { "title": "UpdateGlobalProfileRequestDynamicApplicationRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestFlowBasedAntivirusProfileRef": { "title": "UpdateGlobalProfileRequestFlowBasedAntivirusProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestIcapProfileRef": { "title": "UpdateGlobalProfileRequestIcapProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestIpsProfileRef": { "title": "UpdateGlobalProfileRequestIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestSecintelProfileGroupRef": { "title": "UpdateGlobalProfileRequestSecintelProfileGroupRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestSslProxyProfileRef": { "title": "UpdateGlobalProfileRequestSslProxyProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestSwpProfileRef": { "title": "UpdateGlobalProfileRequestSwpProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalProfileRequestUtmProfileRef": { "title": "UpdateGlobalProfileRequestUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile", "readOnly": true } } }, "UpdateGlobalSettingsRequestAamwProfileRef": { "title": "UpdateGlobalSettingsRequestAamwProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "UpdateGlobalSettingsRequestIpsProfileRef": { "title": "UpdateGlobalSettingsRequestIpsProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "UpdateGlobalSettingsRequestSecintelProfileGroupRef": { "title": "UpdateGlobalSettingsRequestSecintelProfileGroupRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "UpdateGlobalSettingsRequestSslProxyProfileRef": { "title": "UpdateGlobalSettingsRequestSslProxyProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "UpdateGlobalSettingsRequestUtmProfileRef": { "title": "UpdateGlobalSettingsRequestUtmProfileRef", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced profile" }, "name": { "type": "string", "description": "Name of the referenced profile" } } }, "UserFWOptionsAuthenticationAttributes": { "title": "UserFWOptionsAuthenticationAttributes", "type": "object", "properties": { "web_redirect": { "type": "boolean", "description": "Web redirect", "default": false }, "web_redirect_to_https": { "type": "boolean", "description": "Web redirect to https", "default": false }, "web_authentication_server": { "type": "string", "description": "Firewall Web authentication server" }, "ssl_termination_profile": { "type": "string", "description": "Specify SSL termination profileused to the SSL offload" }, "auth_only_browser": { "type": "boolean", "description": "Enable security authentication not responding to non-browser traffic.", "default": false }, "auth_user_agent": { "type": "array", "items": { "type": "string" }, "description": "The security authentication HTTP traffic with specified User-Agent." }, "access_profile_name": { "type": "string", "description": "Access profile name" } } }, "WebFilteringProfileFallbackSettings": { "title": "WebFilteringProfileFallbackSettings", "type": "object", "properties": { "default": { "type": "string", "description": "Fallback default settings. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "server_connectivity": { "type": "string", "description": "Fallback action when device cannot connect to server. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "timeout": { "type": "string", "description": "Fallback action when connection to server timeout. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" }, "too_many_requests": { "type": "string", "description": "Fallback action when requests exceed the limit of engine. Allowed values: [LOG_AND_PERMIT, BLOCK, NONE]" } } }, "WebFilteringProfileSiteReputationActions": { "title": "WebFilteringProfileSiteReputationActions", "type": "object", "properties": { "moderately_safe": { "type": "string", "description": "Action when site reputation is moderately safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "harmful": { "type": "string", "description": "Action when site reputation is harmful. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "suspicious": { "type": "string", "description": "Action when site reputation is suspicious. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "very_safe": { "type": "string", "description": "Action when site reputation is very safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "fairly_safe": { "type": "string", "description": "Action when site reputation is fairly safe. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" } } }, "AVFallbackOptions": { "title": "AVFallbackOptions", "type": "object", "properties": { "engine_error": { "type": "string", "description": "Fallback action for engine not ready. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "default_action": { "type": "string", "description": "Default action. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "timeout": { "type": "string", "description": "Fallback action for engine scan timeout. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "out_of_resources": { "type": "string", "description": "Fallback action for out of resources. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "too_many_requests": { "type": "string", "description": "Fallback action for requests exceed engine limit. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "decompress_error": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "content_size": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" } }, "description": "Anti-virus profile's virus-detection notification options", "example": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } }, "AVNotificationFallbackNonBlock": { "title": "AVNotificationFallbackNonBlock", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } }, "description": "Anti-virus profile's virus-detection notification options", "example": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true } }, "AVNotificationVDFBOptions": { "title": "AVNotificationVDFBOptions", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "type": "string", "description": "Virus detection notification type. Allowed values: [PROTOCOL, MESSAGE, NONE]" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } }, "description": "Anti-virus profile's virus-detection and fallback-block notification options", "example": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true } }, "AVScanOptions": { "title": "AVScanOptions", "type": "object", "properties": { "content_size_limit": { "type": "integer", "description": "content size limit in kilobytes (KB). The limit range is 20-40,000 KB", "format": "int32" } }, "description": "Anti-virus profile's virus-detection notification options", "example": { "content_size_limit": 1 } }, "Address": { "title": "Address", "required": [ "uuid", "name", "address_type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the address object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,63}$" }, "description": { "type": "string", "description": "Description of the address object. Format: ^[^<>&]{0,899}$" }, "address_type": { "type": "string", "description": "Type of the address object. When set to GROUP, only uuid, name, description, address references (group members) are relevant; all other fields are ignored. The types ANY, ANY_IPV6, ANY_IPV4, and ALL_IPV6 are managed by the system—users can view them, but cannot create or modify these types.. Allowed values: [IPADDRESS, GROUP, RANGE, NETWORK, WILDCARD, DNS, POLYMORPHIC, ANY, ANY_IPV4, ANY_IPV6, ALL_IPV6, DYNAMIC_ADDRESS_GROUP, VARIABLE, SECPROFILING_FEED]" }, "ip_address": { "type": "string", "description": "An IPv4/IPv6 host IP address. Examples based on Address Type: IPADDRESS: 192.168.1.100, RANGE: 192.168.1.1-192.168.1.254, NETWORK: 192.168.1.0/24, WILDCARD: 192.168.1.0/0.0.0.255. Applicable only when address_type is not GROUP." }, "host_name": { "type": "string", "description": "Host name of the address. Applicable only when address_type is DNS." }, "update_disabled": { "type": "boolean", "description": "If set to True, object will not be allowed to change. Default is False. Applicable only when address_type is not GROUP.", "default": false }, "address_version": { "type": "string", "description": "Address version of the object. Applicable only when address_type is one of IPADDRESS, RANGE, NETWORK, or WILDCARD.. Allowed values: [IPV4, IPV6, MIXED]" }, "dns_address_type": { "type": "string", "description": "Type of DNS address. Applicable only when address_type is DNS.. Allowed values: [IPV4_ONLY, IPV6_ONLY]" }, "default_address": { "type": "string", "description": "Default value of the address. Applicable only when address_type is VARIABLE." }, "variable_address_map": { "type": "array", "items": { "$ref": "#/components/schemas/VariableAddressMap" }, "description": "Map of devices for this address. Applicable only when address_type is VARIABLE." }, "dag": { "type": "array", "items": { "$ref": "#/components/schemas/DyanmicAddressGroup" }, "description": "Holds Dynamic Address Group properties like Category, Feeds, and Country. Applicable only when address_type is DYNAMIC_ADDRESS_GROUP.. Max length: 1" }, "dag_category": { "type": "string", "description": "Categories of the Dynamic Address Group. Applicable only when address_type is DYNAMIC_ADDRESS_GROUP.. Allowed values: [IPFILTER, GEO_IP, BLACKLIST, INFECTED_HOSTS, NO_CATEGORY]" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/AddressAddressRef" }, "description": "Group members (self-reference). Applicable only when address_type is GROUP. When address_type is GROUP, only uuid, name, description, address references (group members) are relevant; any other fields provided will be ignored." } }, "description": "address object", "example": { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } }, "AddressAddressRef": { "title": "AddressAddressRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to Address", "example": { "uuid": "string" } }, "AddressBasedMapping": { "title": "AddressBasedMapping", "type": "object", "properties": { "address_list": { "type": "array", "items": { "$ref": "#/components/schemas/AddressMappingContent" }, "description": "list of address based mappings" } }, "description": "address based mapping", "example": { "address_list": [ { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } ] } }, "AddressInput": { "title": "AddressInput", "required": [ "name", "address_type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the address object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,63}$" }, "description": { "type": "string", "description": "Description of the address object. Format: ^[^<>&]{0,899}$" }, "address_type": { "type": "string", "description": "Type of the address object. When set to GROUP, only uuid, name, description, address references (group members) are relevant; all other fields are ignored. The types ANY, ANY_IPV6, ANY_IPV4, and ALL_IPV6 are managed by the system—users can view them, but cannot create or modify these types.. Allowed values: [IPADDRESS, GROUP, RANGE, NETWORK, WILDCARD, DNS, POLYMORPHIC, ANY, ANY_IPV4, ANY_IPV6, ALL_IPV6, DYNAMIC_ADDRESS_GROUP, VARIABLE, SECPROFILING_FEED]" }, "ip_address": { "type": "string", "description": "An IPv4/IPv6 host IP address. Examples based on Address Type: IPADDRESS: 192.168.1.100, RANGE: 192.168.1.1-192.168.1.254, NETWORK: 192.168.1.0/24, WILDCARD: 192.168.1.0/0.0.0.255. Applicable only when address_type is not GROUP." }, "host_name": { "type": "string", "description": "Host name of the address. Applicable only when address_type is DNS." }, "update_disabled": { "type": "boolean", "description": "If set to True, object will not be allowed to change. Default is False. Applicable only when address_type is not GROUP.", "default": false }, "address_version": { "type": "string", "description": "Address version of the object. Applicable only when address_type is one of IPADDRESS, RANGE, NETWORK, or WILDCARD.. Allowed values: [IPV4, IPV6, MIXED]" }, "dns_address_type": { "type": "string", "description": "Type of DNS address. Applicable only when address_type is DNS.. Allowed values: [IPV4_ONLY, IPV6_ONLY]" }, "default_address": { "type": "string", "description": "Default value of the address. Applicable only when address_type is VARIABLE." }, "variable_address_map": { "type": "array", "items": { "$ref": "#/components/schemas/VariableAddressMap" }, "description": "Map of devices for this address. Applicable only when address_type is VARIABLE." }, "dag": { "type": "array", "items": { "$ref": "#/components/schemas/DyanmicAddressGroup" }, "description": "Holds Dynamic Address Group properties like Category, Feeds, and Country. Applicable only when address_type is DYNAMIC_ADDRESS_GROUP.. Max length: 1" }, "dag_category": { "type": "string", "description": "Categories of the Dynamic Address Group. Applicable only when address_type is DYNAMIC_ADDRESS_GROUP.. Allowed values: [IPFILTER, GEO_IP, BLACKLIST, INFECTED_HOSTS, NO_CATEGORY]" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/AddressAddressRef" }, "description": "Group members (self-reference). Applicable only when address_type is GROUP. When address_type is GROUP, only uuid, name, description, address references (group members) are relevant; any other fields provided will be ignored." } }, "description": "address object", "example": { "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } }, "AddressMappingContent": { "title": "AddressMappingContent", "type": "object", "properties": { "address_name": { "type": "string", "description": "address name" }, "ip": { "type": "string", "description": "IP address and prefix length" }, "tcp_port": { "type": "string", "description": "tcp port range" }, "udp_port": { "type": "string", "description": "udp port range" }, "cidr": { "type": "string", "description": "IP CIDR" } }, "description": "address mapping content", "example": { "address_name": "string", "ip": "string", "tcp_port": "string", "udp_port": "string", "cidr": "string" } }, "AntiSpamProfile": { "title": "AntiSpamProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the anti-spam object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "sophos_blocklist": { "type": "boolean", "description": "Enables server-based spam filtering. If left off (default), local spam filtering will be used." }, "default_action": { "type": "string", "description": "Default action. Allowed values: [BLOCK_EMAIL, NONE, TAG_HEADER, TAG_SUBJECT]" }, "tag_string": { "type": "string", "description": "Custom tag string" } }, "description": "anti-spam-profiles object", "example": { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } }, "AntiSpamProfileInput": { "title": "AntiSpamProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the anti-spam object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "sophos_blocklist": { "type": "boolean", "description": "Enables server-based spam filtering. If left off (default), local spam filtering will be used." }, "default_action": { "type": "string", "description": "Default action. Allowed values: [BLOCK_EMAIL, NONE, TAG_HEADER, TAG_SUBJECT]" }, "tag_string": { "type": "string", "description": "Custom tag string" } }, "description": "anti-spam-profiles object", "example": { "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } }, "AntiVirusProfile": { "title": "AntiVirusProfile", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the anti-virus-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "profile_type": { "type": "string", "description": "Profile type. Allowed values: [SOPHOS]", "default": "SOPHOS" }, "virus_detection_notification_options": { "$ref": "#/components/schemas/AntiVirusProfileVirusDetectionNotificationOptions" }, "fallback_deny": { "$ref": "#/components/schemas/AntiVirusProfileFallbackDeny" }, "fallback_non_deny": { "$ref": "#/components/schemas/AntiVirusProfileFallbackNonDeny" }, "scan_options": { "$ref": "#/components/schemas/AntiVirusProfileScanOptions" }, "fallback_options": { "$ref": "#/components/schemas/AntiVirusProfileFallbackOptions" } }, "description": "anti-virus-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } }, "AntiVirusProfileInput": { "title": "AntiVirusProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the anti-virus-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "profile_type": { "type": "string", "description": "Profile type. Allowed values: [SOPHOS]", "default": "SOPHOS" }, "virus_detection_notification_options": { "$ref": "#/components/schemas/AntiVirusProfileInputVirusDetectionNotificationOptions" }, "fallback_deny": { "$ref": "#/components/schemas/AntiVirusProfileInputFallbackDeny" }, "fallback_non_deny": { "$ref": "#/components/schemas/AntiVirusProfileInputFallbackNonDeny" }, "scan_options": { "$ref": "#/components/schemas/AntiVirusProfileInputScanOptions" }, "fallback_options": { "$ref": "#/components/schemas/AntiVirusProfileInputFallbackOptions" } }, "description": "anti-virus-profile object", "example": { "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } }, "Application": { "title": "Application", "required": [ "uuid", "name", "app_sig_type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the application signature object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object" }, "signature_version": { "type": "string", "description": "Application Signature version. Value corresponds to signature_version in the signature file. This is mainly required for PREDEFINED applications. Applicable only when app_sig_type is APPLICATION.", "readOnly": true }, "app_id": { "type": "string", "description": "Application ID. Value corresponds to AppID in the signature file. This is mainly required for PREDEFINED applications. Applicable only when app_sig_type is APPLICATION.", "readOnly": true }, "app_sig_type": { "type": "string", "description": "Type of the application signature object. When set to GROUP, only uuid, name, description, application references (group members), and hash_key are relevant; all other fields are ignored.. Allowed values: [APPLICATION, GROUP]" }, "app_device_specific_name": { "type": "string", "description": "Device-specific application name, which may differ from the user-visible name. Required only for PREDEFINED applications. Applicable only when app_sig_type is APPLICATION.", "readOnly": true }, "category": { "type": "string", "description": "Application signature category it belongs to. Applicable only when app_sig_type is APPLICATION." }, "sub_category": { "type": "string", "description": "Application signature subcategory. Applicable only when app_sig_type is APPLICATION." }, "risk": { "type": "string", "description": "Risk value of the application. Accepted values are Low, Moderate, Unsafe, High, and Critical (case-sensitive). Applicable only when app_sig_type is APPLICATION." }, "characteristics": { "type": "array", "items": { "type": "string" }, "description": "List of application characteristics. Applicable only when app_sig_type is APPLICATION." }, "cacheable": { "type": "boolean", "description": "Indicates whether the application is cacheable. If set to true, the application is cacheable. Applicable only when app_sig_type is APPLICATION.", "default": false }, "order": { "type": "integer", "description": "The order value; lower the value, higher the priority (1..50000). Applicable only when app_sig_type is APPLICATION.", "format": "int32" }, "priority": { "type": "string", "description": "Priority field for Custom Application Signature. Accepted values are low and high (case-sensitive). Applicable only when app_sig_type is APPLICATION." }, "application_mapping": { "$ref": "#/components/schemas/ApplicationApplicationMapping" }, "application": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationApplicationRef" }, "description": "Group members (self-reference). Applicable only when app_sig_type is GROUP. When app_sig_type is GROUP, only uuid, name, description, application references (group members), and hash_key are relevant; any other fields provided will be ignored." } }, "description": "application object" }, "ApplicationApplicationRef": { "title": "ApplicationApplicationRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to Application", "example": { "uuid": "string" } }, "ApplicationInput": { "title": "ApplicationInput", "required": [ "name", "app_sig_type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the application signature object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object" }, "app_sig_type": { "type": "string", "description": "Type of the application signature object. When set to GROUP, only uuid, name, description, application references (group members), and hash_key are relevant; all other fields are ignored.. Allowed values: [APPLICATION, GROUP]" }, "category": { "type": "string", "description": "Application signature category it belongs to. Applicable only when app_sig_type is APPLICATION." }, "sub_category": { "type": "string", "description": "Application signature subcategory. Applicable only when app_sig_type is APPLICATION." }, "risk": { "type": "string", "description": "Risk value of the application. Accepted values are Low, Moderate, Unsafe, High, and Critical (case-sensitive). Applicable only when app_sig_type is APPLICATION." }, "characteristics": { "type": "array", "items": { "type": "string" }, "description": "List of application characteristics. Applicable only when app_sig_type is APPLICATION." }, "cacheable": { "type": "boolean", "description": "Indicates whether the application is cacheable. If set to true, the application is cacheable. Applicable only when app_sig_type is APPLICATION.", "default": false }, "order": { "type": "integer", "description": "The order value; lower the value, higher the priority (1..50000). Applicable only when app_sig_type is APPLICATION.", "format": "int32" }, "priority": { "type": "string", "description": "Priority field for Custom Application Signature. Accepted values are low and high (case-sensitive). Applicable only when app_sig_type is APPLICATION." }, "application_mapping": { "$ref": "#/components/schemas/ApplicationInputApplicationMapping" }, "application": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationApplicationRef" }, "description": "Group members (self-reference). Applicable only when app_sig_type is GROUP. When app_sig_type is GROUP, only uuid, name, description, application references (group members), and hash_key are relevant; any other fields provided will be ignored." } }, "description": "application object" }, "ApplicationMappingObject": { "title": "ApplicationMappingObject", "type": "object", "properties": { "icmp_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIcmpBased" }, "ip_protocol_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIpProtocolBased" }, "address_based": { "$ref": "#/components/schemas/ApplicationMappingObjectAddressBased" }, "signature_based": { "$ref": "#/components/schemas/ApplicationMappingObjectSignatureBased" } }, "description": "application mapping details" }, "DAGProperty": { "title": "DAGProperty", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "name or key" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of values. Min length: 1" } }, "description": "Contains DAG Properties like Country, etc.", "example": { "name": "string", "values": [ "string" ] } }, "DestinationOptions": { "title": "DestinationOptions", "type": "object", "properties": { "home-address-option": { "$ref": "#/components/schemas/DestinationOptionsHome-address-option" }, "option-type": { "$ref": "#/components/schemas/DestinationOptionsOption-type" } }, "description": "IPv6 Destination option extension header", "example": { "home-address-option": { "type": "string", "value": "string" }, "option-type": { "type": "string", "value": "string" } } }, "DeviceCertMap": { "title": "DeviceCertMap", "type": "object", "properties": { "cert": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "UUIDS of the local certificate" }, "device_uuid": { "type": "string", "description": "UUID of the devices" } }, "description": "Mapping of devices and local certificates", "example": { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } }, "DyanmicAddressGroup": { "title": "DyanmicAddressGroup", "type": "object", "properties": { "feed": { "type": "string", "description": "Name of feed under DAG Category" }, "feedservername": { "type": "string", "description": "Feed Server Name" }, "path": { "type": "string", "description": "Feed Server Path" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/DAGProperty" }, "description": "Property under DAG Category. Max length: 3" } }, "example": { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } }, "ExtensionHeader": { "title": "ExtensionHeader", "type": "object", "properties": { "routing-header": { "$ref": "#/components/schemas/ExtensionHeaderRouting-header" }, "destination-options": { "$ref": "#/components/schemas/ExtensionHeaderDestination-options" } }, "description": "IPv6 Extension headers", "example": { "routing-header": { "type": "string", "value": "string" }, "destination-options": { "home-address-option": { "type": "string", "value": "string" }, "option-type": { "type": "string", "value": "string" } } } }, "FBAVFallBackActionOptions": { "title": "FBAVFallBackActionOptions", "type": "object", "properties": { "action": { "type": "string", "description": "Action taken for fallback conditions. Allowed values: [permit, block]" }, "notification_log": { "type": "boolean", "description": "Notification action taken for fallback action", "default": false } }, "example": { "action": "string", "notification_log": true } }, "FBAVFallBackOptions": { "title": "FBAVFallBackOptions", "type": "object", "properties": { "action": { "type": "string", "description": "Action taken for fallback conditions. Allowed values: [permit, block]" }, "notification_log": { "type": "boolean", "description": "Notification action taken for fallback action", "default": false }, "invalid_content_size": { "allOf": [ { "$ref": "#/components/schemas/FBAVFallBackActionOptions" }, { "example": { "action": "string", "notification_log": true } } ] }, "out_of_resources": { "allOf": [ { "$ref": "#/components/schemas/FBAVFallBackActionOptions" }, { "example": { "action": "string", "notification_log": true } } ] }, "service_not_ready": { "allOf": [ { "$ref": "#/components/schemas/FBAVFallBackActionOptions" }, { "example": { "action": "string", "notification_log": true } } ] } }, "example": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } }, "FBAVHttpClientNotification": { "title": "FBAVHttpClientNotification", "type": "object", "properties": { "file": { "type": "string", "description": "File name for http response to client" }, "message": { "type": "string", "description": "Block message to client" }, "redirect_url": { "type": "string", "description": "Redirect url to client" } }, "example": { "file": "string", "message": "string", "redirect_url": "string" } }, "FallbackOptions": { "title": "FallbackOptions", "type": "object", "properties": { "timeout_action": { "type": "string", "description": "request a valid timeout option. Allowed values: [none, permit, log_permit, block]" }, "connectivity_failure_action": { "type": "string", "description": "select a valid connectivity action. Allowed values: [none, permit, log_permit, block]" }, "default_failure_action": { "type": "string", "description": "select a default option other than timeout and connectivity failure issues.. Allowed values: [none, permit, log_permit, block]" } }, "description": "fallback options", "example": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" } }, "FilterContent": { "title": "FilterContent", "type": "object", "properties": { "expression": { "type": "string", "description": "Expression of the filter" }, "field": { "type": "string", "description": "Field of the filter" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values of the filter" } }, "description": "Filter attribute for ips signature groups", "example": { "expression": "string", "field": "string", "values": [ "string" ] } }, "FlowBasedAntivirusProfile": { "title": "FlowBasedAntivirusProfile", "required": [ "uuid", "name", "verdict_threshold", "action" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the flow based anti-virus profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "verdict_threshold": { "type": "string", "description": "The threshold value to determine when a file is considered infected. Accepts values from 1 to 10." }, "action": { "type": "string", "description": "Action choice to take when a file meets the verdict threshold. Allowed values: block, permit. Default is block.. Allowed values: [permit, block]" }, "default_notification": { "type": "boolean", "description": "Notification log when file does not meet the verdict threshold. Default is false.", "default": false }, "notification": { "type": "boolean", "description": "Notification action taken for contents with verdict meeting the threshold. Default is false.", "default": false }, "http_client_notify": { "allOf": [ { "$ref": "#/components/schemas/FBAVHttpClientNotification" }, { "example": { "file": "string", "message": "string", "redirect_url": "string" } } ] }, "fallback_options": { "allOf": [ { "$ref": "#/components/schemas/FBAVFallBackOptions" }, { "example": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } ] } }, "description": "flow based anti-virus profile object", "example": { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } }, "FlowBasedAntivirusProfileInput": { "title": "FlowBasedAntivirusProfileInput", "required": [ "name", "verdict_threshold", "action" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the flow based anti-virus profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "verdict_threshold": { "type": "string", "description": "The threshold value to determine when a file is considered infected. Accepts values from 1 to 10." }, "action": { "type": "string", "description": "Action choice to take when a file meets the verdict threshold. Allowed values: block, permit. Default is block.. Allowed values: [permit, block]" }, "default_notification": { "type": "boolean", "description": "Notification log when file does not meet the verdict threshold. Default is false.", "default": false }, "notification": { "type": "boolean", "description": "Notification action taken for contents with verdict meeting the threshold. Default is false.", "default": false }, "http_client_notify": { "allOf": [ { "$ref": "#/components/schemas/FBAVHttpClientNotification" }, { "example": { "file": "string", "message": "string", "redirect_url": "string" } } ] }, "fallback_options": { "allOf": [ { "$ref": "#/components/schemas/FBAVFallBackOptions" }, { "example": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } ] } }, "description": "flow based anti-virus profile object", "example": { "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } }, "IPFlags": { "title": "IPFlags", "type": "object", "properties": { "df": { "type": "boolean", "description": "Don't Fragment bit", "default": false }, "mf": { "type": "boolean", "description": "More Fragment bit", "default": false }, "rb": { "type": "boolean", "description": "Reserved bit", "default": false }, "no-df": { "type": "boolean", "description": "Don't set Don't Fragment bit", "default": false }, "no-mf": { "type": "boolean", "description": "Don't set More Fragment bit", "default": false }, "no-rb": { "type": "boolean", "description": "Don't set Reserved bit", "default": false } }, "description": "IP Flag bits for IPv4 protocol", "example": { "df": true, "mf": true, "rb": true, "no-df": true, "no-mf": true, "no-rb": true } }, "IPSProtocolParameters": { "title": "IPSProtocolParameters", "type": "object", "properties": { "IPV6": { "$ref": "#/components/schemas/IPSProtocolParametersIpv6" }, "IPV4": { "$ref": "#/components/schemas/IPSProtocolParametersIpv4" } }, "description": "Contains protocol parameters for IPS signature" }, "IPV4ProtocolParameters": { "title": "IPV4ProtocolParameters", "type": "object", "properties": { "checksum-validate": { "$ref": "#/components/schemas/IPV4ProtocolParametersChecksum-validate" }, "destination": { "$ref": "#/components/schemas/IPV4ProtocolParametersDestination" }, "identification": { "$ref": "#/components/schemas/IPV4ProtocolParametersIdentification" }, "ihl": { "$ref": "#/components/schemas/IPV4ProtocolParametersIhl" }, "ip-flags": { "$ref": "#/components/schemas/IPV4ProtocolParametersIp-flags" }, "protocol": { "$ref": "#/components/schemas/IPV4ProtocolParametersProtocol" }, "source": { "$ref": "#/components/schemas/IPV4ProtocolParametersSource" }, "tos": { "$ref": "#/components/schemas/IPV4ProtocolParametersTos" }, "total-length": { "$ref": "#/components/schemas/IPV4ProtocolParametersTotal-length" }, "ttl": { "$ref": "#/components/schemas/IPV4ProtocolParametersTtl" } }, "description": "Contains protocol parameters for IPV4 signature", "example": { "checksum-validate": { "type": "string", "value": "string" }, "destination": { "type": "string", "value": "string" }, "identification": { "type": "string", "value": "string" }, "ihl": { "type": "string", "value": "string" }, "ip-flags": { "df": true, "mf": true, "rb": true, "no-df": true, "no-mf": true, "no-rb": true }, "protocol": { "type": "string", "value": "string" }, "source": { "type": "string", "value": "string" }, "tos": { "type": "string", "value": "string" }, "total-length": { "type": "string", "value": "string" }, "ttl": { "type": "string", "value": "string" } } }, "IPV6ProtocolParameters": { "title": "IPV6ProtocolParameters", "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/IPV6ProtocolParametersDestination" }, "extension-header": { "$ref": "#/components/schemas/IPV6ProtocolParametersExtension-header" }, "flow-label": { "$ref": "#/components/schemas/IPV6ProtocolParametersFlow-label" }, "hop-limit": { "$ref": "#/components/schemas/IPV6ProtocolParametersHop-limit" }, "next-header": { "$ref": "#/components/schemas/IPV6ProtocolParametersNext-header" }, "payload-length": { "$ref": "#/components/schemas/IPV6ProtocolParametersPayload-length" }, "source": { "$ref": "#/components/schemas/IPV6ProtocolParametersSource" }, "traffic-class": { "$ref": "#/components/schemas/IPV6ProtocolParametersTraffic-class" } }, "description": "Contains protocol parameters for IPV6 signature", "example": { "destination": { "type": "string", "value": "string" }, "extension-header": { "routing-header": { "type": "string", "value": "string" }, "destination-options": { "home-address-option": { "type": "string", "value": "string" }, "option-type": { "type": "string", "value": "string" } } }, "flow-label": { "type": "string", "value": "string" }, "hop-limit": { "type": "string", "value": "string" }, "next-header": { "type": "string", "value": "string" }, "payload-length": { "type": "string", "value": "string" }, "source": { "type": "string", "value": "string" }, "traffic-class": { "type": "string", "value": "string" } } }, "IcapProfile": { "title": "IcapProfile", "required": [ "uuid", "name", "icap_server" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the icap profile object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "timeout": { "type": "integer", "description": "Options after timeout", "format": "int32" }, "http_redirect_option": { "type": "string", "description": "enable or disable redirect option. Allowed values: [request, response, response_and_request]" }, "fallback_options": { "$ref": "#/components/schemas/IcapProfileFallbackOptions" }, "icap_server": { "type": "array", "items": { "$ref": "#/components/schemas/IcapProfileIcapServerRef" }, "description": "reference for icap_server" } }, "description": "icap-profile object", "example": { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } }, "IcapProfileIcapServerRef": { "title": "IcapProfileIcapServerRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to IcapServer", "example": { "uuid": "string" } }, "IcapProfileInput": { "title": "IcapProfileInput", "required": [ "name", "icap_server" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the icap profile object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "timeout": { "type": "integer", "description": "Options after timeout", "format": "int32" }, "http_redirect_option": { "type": "string", "description": "enable or disable redirect option. Allowed values: [request, response, response_and_request]" }, "fallback_options": { "$ref": "#/components/schemas/IcapProfileInputFallbackOptions" }, "icap_server": { "type": "array", "items": { "$ref": "#/components/schemas/IcapProfileIcapServerRef" }, "description": "reference for icap_server" } }, "description": "icap-profile object", "example": { "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } }, "IcapServer": { "title": "IcapServer", "required": [ "uuid", "name", "host" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the Icap server Profile. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "host": { "type": "string", "description": "hostname or ip address" }, "password_base64": { "type": "string", "description": "base64 password for user authentication" }, "password_ascii": { "type": "string", "description": "ascii password for user authentication" }, "port": { "type": "integer", "description": "ICAP server listening port", "format": "int32" }, "no_of_sessions": { "type": "integer", "description": "number of connections to create the ICAP service", "format": "int32" }, "request_mod_path": { "type": "string", "description": "path to service that handles Request modification requests." }, "response_mod_path": { "type": "string", "description": "path to service that handles Response modification requests." }, "routing_instance": { "type": "string", "description": "virtual router used for launching the service" }, "ssl_initiation_profile": { "$ref": "#/components/schemas/IcapServerSslInitiationProfile" }, "ssl_initiation": { "type": "array", "items": { "$ref": "#/components/schemas/IcapServerSSLInitiationRef" }, "description": "reference schema for ssl initiation" } }, "description": "icap server object", "example": { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } }, "IcapServerInput": { "title": "IcapServerInput", "required": [ "name", "host" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the Icap server Profile. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "host": { "type": "string", "description": "hostname or ip address" }, "password_base64": { "type": "string", "description": "base64 password for user authentication" }, "password_ascii": { "type": "string", "description": "ascii password for user authentication" }, "port": { "type": "integer", "description": "ICAP server listening port", "format": "int32" }, "no_of_sessions": { "type": "integer", "description": "number of connections to create the ICAP service", "format": "int32" }, "request_mod_path": { "type": "string", "description": "path to service that handles Request modification requests." }, "response_mod_path": { "type": "string", "description": "path to service that handles Response modification requests." }, "routing_instance": { "type": "string", "description": "virtual router used for launching the service" }, "ssl_initiation_profile": { "$ref": "#/components/schemas/IcapServerInputSslInitiationProfile" }, "ssl_initiation": { "type": "array", "items": { "$ref": "#/components/schemas/IcapServerSSLInitiationRef" }, "description": "reference schema for ssl initiation" } }, "description": "icap server object", "example": { "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } }, "IcapServerSSLInitiationRef": { "title": "IcapServerSSLInitiationRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to SSLInitiation", "example": { "uuid": "string" } }, "IcmpBasedMapping": { "title": "IcmpBasedMapping", "type": "object", "properties": { "icmp_code": { "type": "integer", "description": "icmp code to be matched", "format": "int32" }, "icmp_type": { "type": "integer", "description": "icmp type to be matched", "format": "int32" } }, "description": "icmp_based mapping", "example": { "icmp_code": 1, "icmp_type": 1 } }, "IdentityObject": { "title": "IdentityObject", "required": [ "uuid", "name", "identity_type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the user. Format: ^[a-zA-Z0-9][a-zA-Z0-9_ .:\\\\/\\\\-]{0,128}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "identity_type": { "type": "string", "description": "Identity Object type. Allowed values: [USER, GROUP]" }, "identity_domain": { "type": "string", "description": "Identity Object domain name. Applicable only when identity_type is GROUP. Must be empty when identity_type is USER; the request will be rejected if a value is provided." }, "identity_object": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityObjectIdentityObjectRef" }, "description": "Self reference for identity_object group. Applicable only when identity_type is GROUP. Must be empty when identity_type is USER; the request will be rejected if a value is provided." } }, "description": "identity object", "example": { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } }, "IdentityObjectIdentityObjectRef": { "title": "IdentityObjectIdentityObjectRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to IdentityObject", "example": { "uuid": "string" } }, "IdentityObjectInput": { "title": "IdentityObjectInput", "required": [ "name", "identity_type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user. Format: ^[a-zA-Z0-9][a-zA-Z0-9_ .:\\\\/\\\\-]{0,128}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "identity_type": { "type": "string", "description": "Identity Object type. Allowed values: [USER, GROUP]" }, "identity_domain": { "type": "string", "description": "Identity Object domain name. Applicable only when identity_type is GROUP. Must be empty when identity_type is USER; the request will be rejected if a value is provided." }, "identity_object": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityObjectIdentityObjectRef" }, "description": "Self reference for identity_object group. Applicable only when identity_type is GROUP. Must be empty when identity_type is USER; the request will be rejected if a value is provided." } }, "description": "identity object", "example": { "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } }, "IpProtocolBasedMapping": { "title": "IpProtocolBasedMapping", "type": "object", "properties": { "ip_protocol": { "type": "integer", "description": "protocol to be matched", "format": "int32" } }, "description": "ip protocol based mapping", "example": { "ip_protocol": 1 } }, "IpsContext": { "title": "IpsContext", "required": [ "uuid", "import_id" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "import_id": { "type": "string", "description": "IPS Context ID" }, "sensitivity": { "type": "string", "description": "IPS Context sensitivity" }, "direction": { "type": "string", "description": "IPS Context direction" }, "variability": { "type": "string", "description": "IPS Context variability" }, "interest": { "type": "string", "description": "IPS Context interest" }, "service": { "type": "string", "description": "IPS Context service" } }, "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } }, "IpsProfileInput": { "title": "IpsProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object. Format: ^[^#&;\\r\\n ]{1,127}$" }, "description": { "type": "string", "description": "Description of the object" } }, "example": { "name": "string", "description": "string" } }, "IpsService": { "title": "IpsService", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object, defaults to 'default-'" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "import_id": { "type": "string" }, "line": { "type": "string" }, "transaction": { "type": "string" } }, "example": { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } }, "IpsSignature": { "title": "IpsSignature", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the IPS signature or group." }, "description": { "type": "string", "description": "Detailed information about the IPS signature or group." }, "signature_type": { "type": "string", "description": "Type of IPS Signature.. Allowed values: [anomaly, signature, chain, static, dynamic]" }, "import_id": { "type": "string", "description": "IPS Signature ID as per the signature bundle. Applicable only for predefined signatures imported from signature bundles, not for custom signatures or groups", "readOnly": true }, "activation_date": { "type": "string", "description": "Date and time when the signature was activated.", "readOnly": true }, "modified": { "type": "string", "description": "Date and time when the signature was last modified." }, "severity": { "type": "string", "description": "Severity of the IPS signature that matches the lethality of this attack on your network. Required for anomaly/signature/chain types" }, "recommended": { "type": "boolean", "description": "Indicates whether the signature is recommended. Applicable for anomaly/signature/chain types.", "default": false }, "recommended_action": { "type": "string", "description": "Recommended action to be taken for the signature (e.g., close, close-server, drop, ignore, none). Required for anomaly/signature/chain types.. Allowed values: [close, close-client, close-server, drop, drop-packet, ignore, none]" }, "vulnerability_id": { "type": "string", "description": "Vulnerability ID of the signature.", "readOnly": true }, "service": { "type": "string", "description": "Service associated with the signature (e.g., HTTP, TCP, FTP). Applicable for anomaly/signature/chain types." }, "cve": { "type": "string", "description": "Common Vulnerabilities and Exposures (CVE) identifier associated with the signature.", "readOnly": true }, "bugtraq": { "type": "string", "description": "BugTraq ID associated with the security vulnerability.", "readOnly": true }, "url": { "type": "string", "description": "Reference URL providing additional information about the signature.", "readOnly": true }, "cert": { "type": "string", "description": "CERT advisory identifier associated with the signature.", "readOnly": true }, "direction": { "type": "string", "description": "Connection direction of the attack (e.g., any, client-to-server, server-to-client). Applicable for anomaly/signature/chain types" }, "cvss_score": { "type": "array", "items": { "type": "string" }, "description": "Common Vulnerability Scoring System (CVSS) score of the attack, ranging from 0 to 10, with 10 being the most severe. Applicable for anomaly/signature/chain types." }, "file_type": { "type": "array", "items": { "type": "string" }, "description": "File type the attack is valid for (e.g., PDF, EXE). Applicable for anomaly/signature/chain types" }, "vulnerability_type": { "type": "array", "items": { "type": "string" }, "description": "Vulnerability type of the attack (e.g., buffer overflow, injection, use-after-free, XSS, RCE). Applicable for anomaly/signature/chain types." }, "excluded": { "type": "boolean", "description": "Indicates whether the signature is excluded.", "default": false }, "update_status": { "type": "string", "description": "Status of the signature after the latest signature update (e.g., added, modified, renamed).", "readOnly": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/FilterContent" }, "description": "Filter criteria for dynamic groups. Required when signature_type is 'dynamic'." }, "pattern_sets": { "type": "array", "items": { "$ref": "#/components/schemas/PatternSetContent" }, "description": "List of pattern sets defining the attack detection logic. Required for signature_type 'anomaly', 'signature', or 'chain'." }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/IpsSignatureIpsSignatureRef" }, "description": "Self-reference for groups. Used when signature type is 'static' to specify array of existing signature UUIDs that belong to this static group. Not applicable for anomaly/signature/chain or dynamic types" } }, "description": "ips_signature object" }, "IpsSignatureInput": { "title": "IpsSignatureInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the IPS signature or group." }, "description": { "type": "string", "description": "Detailed information about the IPS signature or group." }, "signature_type": { "type": "string", "description": "Type of IPS Signature.. Allowed values: [anomaly, signature, chain, static, dynamic]" }, "modified": { "type": "string", "description": "Date and time when the signature was last modified." }, "severity": { "type": "string", "description": "Severity of the IPS signature that matches the lethality of this attack on your network. Required for anomaly/signature/chain types" }, "recommended": { "type": "boolean", "description": "Indicates whether the signature is recommended. Applicable for anomaly/signature/chain types.", "default": false }, "recommended_action": { "type": "string", "description": "Recommended action to be taken for the signature (e.g., close, close-server, drop, ignore, none). Required for anomaly/signature/chain types.. Allowed values: [close, close-client, close-server, drop, drop-packet, ignore, none]" }, "service": { "type": "string", "description": "Service associated with the signature (e.g., HTTP, TCP, FTP). Applicable for anomaly/signature/chain types." }, "direction": { "type": "string", "description": "Connection direction of the attack (e.g., any, client-to-server, server-to-client). Applicable for anomaly/signature/chain types" }, "cvss_score": { "type": "array", "items": { "type": "string" }, "description": "Common Vulnerability Scoring System (CVSS) score of the attack, ranging from 0 to 10, with 10 being the most severe. Applicable for anomaly/signature/chain types." }, "file_type": { "type": "array", "items": { "type": "string" }, "description": "File type the attack is valid for (e.g., PDF, EXE). Applicable for anomaly/signature/chain types" }, "vulnerability_type": { "type": "array", "items": { "type": "string" }, "description": "Vulnerability type of the attack (e.g., buffer overflow, injection, use-after-free, XSS, RCE). Applicable for anomaly/signature/chain types." }, "excluded": { "type": "boolean", "description": "Indicates whether the signature is excluded.", "default": false }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/FilterContent" }, "description": "Filter criteria for dynamic groups. Required when signature_type is 'dynamic'." }, "pattern_sets": { "type": "array", "items": { "$ref": "#/components/schemas/PatternSetContent" }, "description": "List of pattern sets defining the attack detection logic. Required for signature_type 'anomaly', 'signature', or 'chain'." }, "ips_signature": { "type": "array", "items": { "$ref": "#/components/schemas/IpsSignatureIpsSignatureRef" }, "description": "Self-reference for groups. Used when signature type is 'static' to specify array of existing signature UUIDs that belong to this static group. Not applicable for anomaly/signature/chain or dynamic types" } }, "description": "ips_signature object" }, "IpsSignatureIpsSignatureRef": { "title": "IpsSignatureIpsSignatureRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to IpsSignature", "example": { "uuid": "string" } }, "IpsVulnerability": { "title": "IpsVulnerability", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "version_no": { "type": "string" }, "import_id": { "type": "string" }, "package_type": { "type": "string" }, "vendor": { "type": "string" }, "title": { "type": "string" } }, "example": { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } }, "ListAddressResponse": { "title": "ListAddressResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Address" }, "description": "List of addresss" }, "count": { "type": "string", "description": "Total count of addresss" } }, "description": "Response containing a list of addresss", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_type": "string", "ip_address": "string", "host_name": "string", "update_disabled": true, "address_version": "string", "dns_address_type": "string", "default_address": "string", "variable_address_map": [ { "device_uuid": "string", "address_uuid": "string" } ], "dag": [ { "feed": "string", "feedservername": "string", "path": "string", "properties": [ { "name": "string", "values": [ "string" ] } ] } ], "dag_category": "string", "address": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListAntiSpamProfileResponse": { "title": "ListAntiSpamProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AntiSpamProfile" }, "description": "List of anti spam profiles" }, "count": { "type": "string", "description": "Total count of anti spam profiles" } }, "description": "Response containing a list of anti spam profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "sophos_blocklist": true, "default_action": "string", "tag_string": "string" } ], "count": "string" } }, "ListAntiVirusProfileResponse": { "title": "ListAntiVirusProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AntiVirusProfile" }, "description": "List of anti virus profiles" }, "count": { "type": "string", "description": "Total count of anti virus profiles" } }, "description": "Response containing a list of anti virus profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "profile_type": "string", "virus_detection_notification_options": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_deny": { "custom_notification_message": "string", "notification_type": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "fallback_non_deny": { "custom_notification_message": "string", "custom_notification_subject": "string", "notify_mail_sender": true }, "scan_options": { "content_size_limit": 1 }, "fallback_options": { "engine_error": "string", "default_action": "string", "timeout": "string", "out_of_resources": "string", "too_many_requests": "string", "decompress_error": "string", "content_size": "string" } } ], "count": "string" } }, "ListApplicationResponse": { "title": "ListApplicationResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Application" }, "description": "List of applications" }, "count": { "type": "string", "description": "Total count of applications" } }, "description": "Response containing a list of applications", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "signature_version": "string", "app_id": "string", "app_sig_type": "string", "app_device_specific_name": "string", "category": "string", "sub_category": "string", "risk": "string", "characteristics": [ "string" ], "cacheable": true, "order": 1, "priority": "string", "application_mapping": { "icmp_based": { "icmp_code": 1, "icmp_type": 1 }, "ip_protocol_based": { "ip_protocol": 1 }, "address_based": { "address_list": [ {} ] }, "signature_based": { "protocol": [ {} ] } }, "application": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListFlowBasedAntivirusProfileResponse": { "title": "ListFlowBasedAntivirusProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FlowBasedAntivirusProfile" }, "description": "List of flow based antivirus profiles" }, "count": { "type": "string", "description": "Total count of flow based antivirus profiles" } }, "description": "Response containing a list of flow based antivirus profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "verdict_threshold": "string", "action": "string", "default_notification": true, "notification": true, "http_client_notify": { "file": "string", "message": "string", "redirect_url": "string" }, "fallback_options": { "action": "string", "notification_log": true, "invalid_content_size": { "action": "string", "notification_log": true }, "out_of_resources": { "action": "string", "notification_log": true }, "service_not_ready": { "action": "string", "notification_log": true } } } ], "count": "string" } }, "ListIcapProfileResponse": { "title": "ListIcapProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IcapProfile" }, "description": "List of icap profiles" }, "count": { "type": "string", "description": "Total count of icap profiles" } }, "description": "Response containing a list of icap profiles", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "timeout": 1, "http_redirect_option": "string", "fallback_options": { "timeout_action": "string", "connectivity_failure_action": "string", "default_failure_action": "string" }, "icap_server": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListIcapServerResponse": { "title": "ListIcapServerResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IcapServer" }, "description": "List of icap servers" }, "count": { "type": "string", "description": "Total count of icap servers" } }, "description": "Response containing a list of icap servers", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "host": "string", "password_base64": "string", "password_ascii": "string", "port": 1, "no_of_sessions": 1, "request_mod_path": "string", "response_mod_path": "string", "routing_instance": "string", "ssl_initiation_profile": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" }, "ssl_initiation": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListIdentityObjectResponse": { "title": "ListIdentityObjectResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityObject" }, "description": "List of identity objects" }, "count": { "type": "string", "description": "Total count of identity objects" } }, "description": "Response containing a list of identity objects", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "identity_type": "string", "identity_domain": "string", "identity_object": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListIpsContextResponse": { "title": "ListIpsContextResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IpsContext" }, "description": "List of ips contexts" }, "count": { "type": "string", "description": "Total count of ips contexts" } }, "description": "Response containing a list of ips contexts", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "sensitivity": "string", "direction": "string", "variability": "string", "interest": "string", "service": "string" } ], "count": "string" } }, "ListIpsServiceResponse": { "title": "ListIpsServiceResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IpsService" }, "description": "List of ips services" }, "count": { "type": "string", "description": "Total count of ips services" } }, "description": "Response containing a list of ips services", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "import_id": "string", "line": "string", "transaction": "string" } ], "count": "string" } }, "ListIpsSignatureResponse": { "title": "ListIpsSignatureResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IpsSignature" }, "description": "List of ips signatures" }, "count": { "type": "string", "description": "Total count of ips signatures" } }, "description": "Response containing a list of ips signatures" }, "ListIpsVulnerabilityResponse": { "title": "ListIpsVulnerabilityResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IpsVulnerability" }, "description": "List of ips vulnerabilitys" }, "count": { "type": "string", "description": "Total count of ips vulnerabilitys" } }, "description": "Response containing a list of ips vulnerabilitys", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "version_no": "string", "import_id": "string", "package_type": "string", "vendor": "string", "title": "string" } ], "count": "string" } }, "ListProxyServerResponse": { "title": "ListProxyServerResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyServer" }, "description": "List of proxy servers" }, "count": { "type": "string", "description": "Total count of proxy servers" } }, "description": "Response containing a list of proxy servers", "example": { "items": [ { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } ], "count": "string" } }, "ListRedirectProfileResponse": { "title": "ListRedirectProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RedirectProfile" }, "description": "List of redirect profiles" }, "count": { "type": "string", "description": "Total count of redirect profiles" } }, "description": "Response containing a list of redirect profiles", "example": { "items": [ { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } ], "count": "string" } }, "ListSSLInitiationResponse": { "title": "ListSSLInitiationResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SSLInitiation" }, "description": "List of sslinitiations" }, "count": { "type": "string", "description": "Total count of sslinitiations" } }, "description": "Response containing a list of sslinitiations", "example": { "items": [ { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } ], "count": "string" } }, "ListSWPProfileResponse": { "title": "ListSWPProfileResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SWPProfile" }, "description": "List of swpprofiles" }, "count": { "type": "string", "description": "Total count of swpprofiles" } }, "description": "Response containing a list of swpprofiles", "example": { "items": [ { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListSchedulerResponse": { "title": "ListSchedulerResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Scheduler" }, "description": "List of schedulers" }, "count": { "type": "string", "description": "Total count of schedulers" } }, "description": "Response containing a list of schedulers", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } ], "count": "string" } }, "ListSecintelProfileGroupResponse": { "title": "ListSecintelProfileGroupResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroup" }, "description": "List of secintel profile groups" }, "count": { "type": "string", "description": "Total count of secintel profile groups" } }, "description": "Response containing a list of secintel profile groups", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListServicesResponse": { "title": "ListServicesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Services" }, "description": "List of servicess" }, "count": { "type": "string", "description": "Total count of servicess" } }, "description": "Response containing a list of servicess", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListURLCategoryListResponse": { "title": "ListURLCategoryListResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/URLCategoryList" }, "description": "List of urlcategory lists" }, "count": { "type": "string", "description": "Total count of urlcategory lists" } }, "description": "Response containing a list of urlcategory lists", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } ], "count": "string" } }, "ListURLPatternsResponse": { "title": "ListURLPatternsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/URLPatterns" }, "description": "List of urlpatternss" }, "count": { "type": "string", "description": "Total count of urlpatternss" } }, "description": "Response containing a list of urlpatternss", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } ], "count": "string" } }, "ListVariableZoneResponse": { "title": "ListVariableZoneResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VariableZone" }, "description": "List of variable zones" }, "count": { "type": "string", "description": "Total count of variable zones" } }, "description": "Response containing a list of variable zones", "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } ], "count": "string" } }, "MatchValue": { "title": "MatchValue", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } }, "description": "Contains match value for variable address case", "example": { "type": "string", "value": "string" } }, "PatternMember": { "title": "PatternMember", "type": "object", "properties": { "member_type": { "type": "string", "description": "Type of the pattern member. Allowed values: [anomaly, signature]" }, "order": { "type": "string", "description": "Order of the pattern", "readOnly": true }, "member_name": { "type": "string", "description": "Name of the member" }, "negated": { "type": "boolean", "description": "Whether or not to negate pattern", "default": false }, "pattern": { "type": "string", "description": "Pattern value" }, "regex": { "type": "string", "description": "Regex of the pattern" }, "direction": { "type": "string", "description": "Direction value of pattern. Allowed values: [any, cts, stc]" }, "context": { "type": "string", "description": "Context of the pattern" }, "shellcode": { "type": "string", "description": "Presence of shell code", "readOnly": true }, "anomaly_test": { "type": "string", "description": "Test value of the Anomaly" } }, "description": "This is a part of member in patternset", "example": { "member_type": "string", "order": "string", "member_name": "string", "negated": true, "pattern": "string", "regex": "string", "direction": "string", "context": "string", "shellcode": "string", "anomaly_test": "string" } }, "PatternSetContent": { "title": "PatternSetContent", "type": "object", "properties": { "service": { "type": "string", "description": "Service name" }, "port": { "type": "string", "description": "port number in the format PORT:PORT_NUMBER. For ex: TCP:35-100 or IP:55" }, "protocol_parameters": { "$ref": "#/components/schemas/PatternSetContentProtocolParameters" }, "time_scope": { "type": "string", "description": "Time scope. Allowed values: [peer, src-ip, dst-ip]" }, "time_count": { "type": "string", "description": "Time count of pattern set" }, "flow": { "type": "string", "description": "Flow of pattern set", "readOnly": true }, "scope": { "type": "string", "description": "Scope of pattern set. Allowed values: [session, transaction]" }, "reset": { "type": "boolean", "description": "Reset the patternset", "default": false, "readOnly": true }, "expression": { "type": "string", "description": "Expression of patten set" }, "order": { "type": "string", "description": "Order of the pattern set", "readOnly": true }, "ordered": { "type": "boolean", "description": "Whether patten set should be ordered", "default": false, "readOnly": true }, "modified": { "type": "string", "description": "Pattern set modified date and time" }, "confidence": { "type": "string", "description": "Confidence of pattern set" }, "performance": { "type": "string", "description": "Slowness of the patternset" }, "encrypted": { "type": "boolean", "description": "Value whether patternset is encrypted", "default": false, "readOnly": true }, "detectors": { "type": "array", "items": { "type": "string" }, "description": "Detectors of pattern set" }, "pattern_members": { "type": "array", "items": { "$ref": "#/components/schemas/PatternMember" }, "description": "Contains list of pattern members" } }, "description": "Grouping pattern set which is included in ips_signature" }, "Protocols": { "title": "Protocols", "required": [ "protocol_type" ], "type": "object", "properties": { "protocol_name": { "type": "string", "description": "name of the protocol term" }, "protocol_description": { "type": "string", "description": "description of the protocol term" }, "alg": { "type": "string", "description": "Layer 7 Protocol" }, "src_port": { "type": "string", "description": "Source Port or Port Ranges" }, "dst_port": { "type": "string", "description": "Destination Port or Port Ranges" }, "disable_timeout": { "type": "boolean", "description": "Disable Timeout of a session", "default": false }, "inactivity_timeout": { "type": "string", "description": "Inactivilty timeout of a session" }, "protocol_type": { "type": "string", "description": "Service protocol family. Allowed values: [PROTOCOL_TCP, PROTOCOL_UDP, PROTOCOL_ICMP, PROTOCOL_SUN_RPC, PROTOCOL_MS_RPC, PROTOCOL_ICMPV6, PROTOCOL_OTHER]" }, "protocol_number": { "type": "string", "description": "Service protocol number" }, "rpc_program_number": { "type": "string", "description": "RPC program number for this protocol, protocol type must be RPC" }, "icmp_code": { "type": "string", "description": "ICMP Code for protocol, protocol type must be ICMP" }, "icmp_type": { "type": "string", "description": "ICMP Type for protocol, protocol type must be ICMP" }, "sun_rpc_protocol_type": { "type": "string", "description": "sun rpc protocol type. Allowed values: [TCP, UDP]" }, "ms_rpc_protocol_type": { "type": "string", "description": "ms rpc protocol type. Allowed values: [TCP, UDP]" }, "ms_rpc_uuid": { "type": "string", "description": "ms rpc protocol uuid" } }, "description": "Definition of protocol referred in service object", "example": { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } }, "ProxyServer": { "title": "ProxyServer", "required": [ "uuid", "name", "ip_address", "port" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the proxy server object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "ip_address": { "type": "string", "description": "IP address" }, "port": { "type": "integer", "description": "Port number (1..65535)", "format": "int32" } }, "description": "proxy server object", "example": { "uuid": "string", "name": "string", "ip_address": "string", "port": 1 } }, "ProxyServerInput": { "title": "ProxyServerInput", "required": [ "name", "ip_address", "port" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the proxy server object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "ip_address": { "type": "string", "description": "IP address" }, "port": { "type": "integer", "description": "Port number (1..65535)", "format": "int32" } }, "description": "proxy server object", "example": { "name": "string", "ip_address": "string", "port": 1 } }, "RedirectProfile": { "title": "RedirectProfile", "required": [ "uuid", "name", "block_message", "block_message_type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object" }, "block_message": { "type": "string", "description": "Block Message." }, "block_message_type": { "type": "string", "description": "Block Message Type.. Allowed values: [REDIRECT_URL, TEXT]" } }, "description": "Redirect profile object", "example": { "uuid": "string", "name": "string", "block_message": "string", "block_message_type": "string" } }, "RedirectProfileInput": { "title": "RedirectProfileInput", "required": [ "name", "block_message", "block_message_type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object" }, "block_message": { "type": "string", "description": "Block Message." }, "block_message_type": { "type": "string", "description": "Block Message Type.. Allowed values: [REDIRECT_URL, TEXT]" } }, "description": "Redirect profile object", "example": { "name": "string", "block_message": "string", "block_message_type": "string" } }, "SSLInitiation": { "title": "SSLInitiation", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the SSL Initiation Profile. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "protocol_version": { "type": "string", "description": "Protocol versions. Allowed values: [None, All, SSL3, TLS_v1, TLS_v1_1, TLS_v1_2, TLS_v1_2_lower, TLS_v1_3]" }, "cipher_strength": { "type": "string", "description": "Cipher Strength. Allowed values: [custom, medium, strong, weak]" }, "flow_tracing": { "type": "boolean", "description": "Enable flow tracing for the profile", "default": false }, "ssl_session_cache": { "type": "boolean", "description": "Enable SSL Session cache for the profile", "default": false }, "default_local_cert": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "Fallback local certificate" }, "device_specific_local_cert": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceCertMap" }, "description": "Device specific local certificate" }, "default_ca_cert": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "Fallback CA certificate" }, "device_specific_ca_cert": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceCertMap" }, "description": "Device specific CA certificate" }, "ignore_server_auth_failure": { "type": "boolean", "description": "Ignore server authentication failure", "default": false }, "crl_validation": { "type": "boolean", "description": "Enable crl validation", "default": false }, "crl_info_unavailable": { "type": "string", "description": "If crl information is unavailable. Allowed values: [drop, allow]" }, "if_cert_revoked": { "type": "string", "description": "If certification is revoked. Allowed values: [drop, allow]" } }, "example": { "uuid": "string", "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } }, "SSLInitiationInput": { "title": "SSLInitiationInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the SSL Initiation Profile. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "protocol_version": { "type": "string", "description": "Protocol versions. Allowed values: [None, All, SSL3, TLS_v1, TLS_v1_1, TLS_v1_2, TLS_v1_2_lower, TLS_v1_3]" }, "cipher_strength": { "type": "string", "description": "Cipher Strength. Allowed values: [custom, medium, strong, weak]" }, "flow_tracing": { "type": "boolean", "description": "Enable flow tracing for the profile", "default": false }, "ssl_session_cache": { "type": "boolean", "description": "Enable SSL Session cache for the profile", "default": false }, "default_local_cert": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "Fallback local certificate" }, "device_specific_local_cert": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceCertMap" }, "description": "Device specific local certificate" }, "default_ca_cert": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectReference" }, "description": "Fallback CA certificate" }, "device_specific_ca_cert": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceCertMap" }, "description": "Device specific CA certificate" }, "ignore_server_auth_failure": { "type": "boolean", "description": "Ignore server authentication failure", "default": false }, "crl_validation": { "type": "boolean", "description": "Enable crl validation", "default": false }, "crl_info_unavailable": { "type": "string", "description": "If crl information is unavailable. Allowed values: [drop, allow]" }, "if_cert_revoked": { "type": "string", "description": "If certification is revoked. Allowed values: [drop, allow]" } }, "example": { "name": "string", "protocol_version": "string", "cipher_strength": "string", "flow_tracing": true, "ssl_session_cache": true, "default_local_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_local_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "default_ca_cert": [ { "uuid": "string", "name": "string" } ], "device_specific_ca_cert": [ { "cert": [ { "uuid": "string", "name": "string" } ], "device_uuid": "string" } ], "ignore_server_auth_failure": true, "crl_validation": true, "crl_info_unavailable": "string", "if_cert_revoked": "string" } }, "SSLInitiationProfile": { "title": "SSLInitiationProfile", "type": "object", "properties": { "ssli_profile_uuid": { "type": "string", "description": "UUID of the ssl initiation profile" }, "ssli_profile_name": { "type": "string", "description": "Name of the ssl initiation profile" } }, "description": "SSL Initiation profile", "example": { "ssli_profile_uuid": "string", "ssli_profile_name": "string" } }, "SSLProxyProfileInput": { "title": "SSLProxyProfileInput", "required": [ "certificates" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "ssl_type": { "type": "string", "description": "SSL proxy profile type. Allowed values: [REVERSE, FORWARD]", "default": "FORWARD" }, "preferred_cipher": { "type": "string", "description": "Preferred cipher associated with the profile.. Allowed values: [none, custom, medium, strong, weak]" }, "custom_cipher": { "type": "array", "items": { "type": "string" }, "description": "The set of ciphers, if the preferred cipher is Custom, which the SSH server uses to perform the encryption and the decryption functions." }, "enable_flow_tracing": { "type": "boolean", "description": "Enable flow tracing for troubleshooting policy-related issues.", "default": false }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/SSLForwardProxyCertificates" }, "description": "Root certificate for interdicting server certificates in proxy mode and List of trusted certificate authority profiles. Root certificate is mandatory.. Min length: 1. Max length: 100000" }, "ignore_server_auth_failure": { "type": "boolean", "description": "To ignore errors encountered during the server certificate verification process (such as CA signature verification failure, self-signed certificates, and certificate expiry).", "default": false }, "disable_session_resumption": { "type": "boolean", "description": "Disable session resumption", "default": false }, "all_log": { "type": "boolean", "description": "Log all events", "default": false }, "info_log": { "type": "boolean", "description": "Log all information events", "default": false }, "warning_log": { "type": "boolean", "description": "Log all warning events", "default": false }, "error_log": { "type": "boolean", "description": "Log all error events", "default": false }, "session_ignored_log": { "type": "boolean", "description": "Log session ignore events", "default": false }, "sessions_allowed_log": { "type": "boolean", "description": "Log ssl session allow events after an error", "default": false }, "sessions_dropped_log": { "type": "boolean", "description": "Log only ssl session drop events", "default": false }, "sessions_white_listed_log": { "type": "boolean", "description": "Log ssl session whitelist events", "default": false }, "renegotiation": { "type": "string", "description": "Indicates the type of renegotiation required for a change in SSL parameters after creating a session and establishing the SSL tunnel transport.. Allowed values: [ALLOW_SECURE, DROP, ALLOW, NONE]" }, "exempted_address": { "type": "array", "items": { "$ref": "#/components/schemas/SSLProxyProfileExemptedAddressRef" }, "description": "Exempted addresses referred in ssl-proxy-profile" }, "whitelist_url_category": { "type": "array", "items": { "$ref": "#/components/schemas/SSLProxyProfileWhitelistURLCategoryRef" }, "description": "Exempted url-category-list referred in ssl-proxy-profile" } }, "description": "SSL Forward proxy profile object", "example": { "name": "string", "description": "string", "ssl_type": "string", "preferred_cipher": "string", "custom_cipher": [ "string" ], "enable_flow_tracing": true, "certificates": [ { "device": { "uuid": "string", "name": "string" }, "root_certificate": { "uuid": "string", "name": "string" }, "trusted_ca": [ { "uuid": "string", "name": "string" } ] } ], "ignore_server_auth_failure": true, "disable_session_resumption": true, "all_log": true, "info_log": true, "warning_log": true, "error_log": true, "session_ignored_log": true, "sessions_allowed_log": true, "sessions_dropped_log": true, "sessions_white_listed_log": true, "renegotiation": "string", "exempted_address": [ { "uuid": "string" } ], "whitelist_url_category": [ { "uuid": "string" } ] } }, "SWPProfile": { "title": "SWPProfile", "required": [ "uuid", "name", "application_signatures", "proxy_server" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "drop_on_dns_error": { "type": "boolean", "description": "drop on dns error", "default": false }, "application_signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SWPProfileApplicationSignaturesRef" }, "description": "application signatures referred in swp_profile" }, "proxy_server": { "type": "array", "items": { "$ref": "#/components/schemas/SWPProfileProxyServerRef" }, "description": "proxy server referred in swp_profile" } }, "description": "swp_profile object", "example": { "uuid": "string", "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } }, "SWPProfileApplicationSignaturesRef": { "title": "SWPProfileApplicationSignaturesRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to ApplicationSignatures", "example": { "uuid": "string" } }, "SWPProfileInput": { "title": "SWPProfileInput", "required": [ "name", "application_signatures", "proxy_server" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "drop_on_dns_error": { "type": "boolean", "description": "drop on dns error", "default": false }, "application_signatures": { "type": "array", "items": { "$ref": "#/components/schemas/SWPProfileApplicationSignaturesRef" }, "description": "application signatures referred in swp_profile" }, "proxy_server": { "type": "array", "items": { "$ref": "#/components/schemas/SWPProfileProxyServerRef" }, "description": "proxy server referred in swp_profile" } }, "description": "swp_profile object", "example": { "name": "string", "drop_on_dns_error": true, "application_signatures": [ { "uuid": "string" } ], "proxy_server": [ { "uuid": "string" } ] } }, "SWPProfileProxyServerRef": { "title": "SWPProfileProxyServerRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to ProxyServer", "example": { "uuid": "string" } }, "ScheduleDefinition": { "title": "ScheduleDefinition", "required": [ "day" ], "type": "object", "properties": { "day": { "type": "string", "description": "Day of the week. Allowed values: [DAILY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]" }, "exclude": { "type": "boolean", "description": "Whether to exclude the specified day of the week or not", "default": false }, "all-day": { "type": "boolean", "description": "True when day specified is DAILY; false otherwise", "default": true }, "id": { "type": "string", "description": "id of the scheduled day" }, "title": { "type": "string", "description": "Title of the scheduled day" }, "start-time1": { "type": "string", "description": "Start time of the first daily time window, specified in HH:MM format (e.g., 08:00). Used when all-day is false to define when the schedule becomes active." }, "stop-time1": { "type": "string", "description": "End time of the first daily time window, specified in HH:MM format (e.g., 17:00). Used when all-day is false to define when the first time window expires." }, "start-time2": { "type": "string", "description": "Start time of the second daily time window, specified in HH:MM format (e.g., 19:00). Use this to define an additional active period within the same day when all-day is false." }, "stop-time2": { "type": "string", "description": "End time of the second daily time window, specified in HH:MM format (e.g., 23:00). Defines when the second time window expires within the same day." } }, "description": "Schedule definition of the day", "example": { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } }, "Scheduler": { "title": "Scheduler", "required": [ "uuid", "name", "schedules" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the scheduler object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the scheduler object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "start-date1": { "type": "string", "description": "Start date/time of the first scheduling window, specified as epoch time in milliseconds (e.g., 1773046187000). Represents the timestamp from which the scheduler becomes active." }, "stop-date1": { "type": "string", "description": "End date/time of the first scheduling window, specified as epoch time in milliseconds (e.g., 1773823790000). Represents the timestamp at which the first scheduling window expires." }, "start-date2": { "type": "string", "description": "Start date/time of the second scheduling window, specified as epoch time in milliseconds (e.g., 1773910193000). Use this to define an additional active period for the scheduler." }, "stop-date2": { "type": "string", "description": "End date/time of the second scheduling window, specified as epoch time in milliseconds (e.g., 1774946995000). Represents the timestamp at which the second scheduling window expires." }, "schedules": { "$ref": "#/components/schemas/SchedulerSchedules2" } }, "description": "Scheduler object", "example": { "uuid": "string", "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } }, "SchedulerInput": { "title": "SchedulerInput", "required": [ "name", "schedules" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the scheduler object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the scheduler object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "start-date1": { "type": "string", "description": "Start date/time of the first scheduling window, specified as epoch time in milliseconds (e.g., 1773046187000). Represents the timestamp from which the scheduler becomes active." }, "stop-date1": { "type": "string", "description": "End date/time of the first scheduling window, specified as epoch time in milliseconds (e.g., 1773823790000). Represents the timestamp at which the first scheduling window expires." }, "start-date2": { "type": "string", "description": "Start date/time of the second scheduling window, specified as epoch time in milliseconds (e.g., 1773910193000). Use this to define an additional active period for the scheduler." }, "stop-date2": { "type": "string", "description": "End date/time of the second scheduling window, specified as epoch time in milliseconds (e.g., 1774946995000). Represents the timestamp at which the second scheduling window expires." }, "schedules": { "$ref": "#/components/schemas/SchedulerInputSchedules" } }, "description": "Scheduler object", "example": { "name": "string", "description": "string", "start-date1": "string", "stop-date1": "string", "start-date2": "string", "stop-date2": "string", "schedules": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } } }, "SchedulerSchedules": { "title": "SchedulerSchedules", "type": "object", "properties": { "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinition" }, "description": "Contains the schedule definition of the day" } }, "description": "object specifying the schedule definition for the days of the every week.", "example": { "schedule": [ { "day": "string", "exclude": true, "all-day": true, "id": "string", "title": "string", "start-time1": "string", "stop-time1": "string", "start-time2": "string", "stop-time2": "string" } ] } }, "SecintelProfileGroup": { "title": "SecintelProfileGroup", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the secintel profile group object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "description of the profile group. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "cc_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupCCSecintelProfileIDRef" }, "description": "profile id of the CC type secintel profile" }, "dns_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupDNSSecintelProfileIDRef" }, "description": "profile id of the DNS type secintel profile" }, "ih_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupIhSecintelProfileIDRef" }, "description": "profile id of the IH type secintel profile" } }, "description": "secintel-profile-groups object", "example": { "uuid": "string", "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } }, "SecintelProfileGroupCCSecintelProfileIDRef": { "title": "SecintelProfileGroupCCSecintelProfileIDRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to CCSecintelProfileID", "example": { "uuid": "string" } }, "SecintelProfileGroupDNSSecintelProfileIDRef": { "title": "SecintelProfileGroupDNSSecintelProfileIDRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to DNSSecintelProfileID", "example": { "uuid": "string" } }, "SecintelProfileGroupIhSecintelProfileIDRef": { "title": "SecintelProfileGroupIhSecintelProfileIDRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to IhSecintelProfileID", "example": { "uuid": "string" } }, "SecintelProfileGroupInput": { "title": "SecintelProfileGroupInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the secintel profile group object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "description of the profile group. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "cc_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupCCSecintelProfileIDRef" }, "description": "profile id of the CC type secintel profile" }, "dns_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupDNSSecintelProfileIDRef" }, "description": "profile id of the DNS type secintel profile" }, "ih_secintel_profile_id": { "type": "array", "items": { "$ref": "#/components/schemas/SecintelProfileGroupIhSecintelProfileIDRef" }, "description": "profile id of the IH type secintel profile" } }, "description": "secintel-profile-groups object", "example": { "name": "string", "description": "string", "cc_secintel_profile_id": [ { "uuid": "string" } ], "dns_secintel_profile_id": [ { "uuid": "string" } ], "ih_secintel_profile_id": [ { "uuid": "string" } ] } }, "SecintelProfileInput": { "title": "SecintelProfileInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the secintel profile object. Format: ^[a-zA-Z0-9_][a-zA-Z0-9-_.:/\\\\s]{0,62}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "feed_category": { "type": "string", "description": "Allowed values: [CC, DNS, Infected-Hosts]" }, "block_action": { "type": "string", "description": "The action to be taken for the blocked feeds.. Allowed values: [close, drop, sinkhole]" }, "close_session_action": { "type": "string", "description": "The action to be taken for the blocked feeds when the action is to close session.. Allowed values: [file, message, redirect-url]" }, "redirect_url": { "type": "string", "description": "HTTP URL redirection for a customized client notification based on detected malware with the block action." }, "redirect_msg": { "type": "string", "description": "The message for a customized client notification based on detected malware with the block action. Range: 1 through 1023" }, "uploaded_file_name": { "type": "string", "description": "name of the file uploaded by user" }, "uploaded_file_content": { "type": "string", "description": "content of the file uploaded by user" }, "default_feeds_action": { "type": "array", "items": { "$ref": "#/components/schemas/FeedsList" }, "description": "stores the default threat score for all the feeds.For example, permit if the score is between 1-4, Log if the score is between 5-6, Block if the score is between 7-10." }, "specific_feeds_action": { "type": "array", "items": { "$ref": "#/components/schemas/FeedsList" }, "description": "stores the user configured threat scores for specific feeds. For example, you can change the action based on the threat scores for individual feeds." } }, "description": "secintel-profile object", "example": { "name": "string", "description": "string", "feed_category": "string", "block_action": "string", "close_session_action": "string", "redirect_url": "string", "redirect_msg": "string", "uploaded_file_name": "string", "uploaded_file_content": "string", "default_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ], "specific_feeds_action": [ { "feeds": [ "string" ], "threat_score": { "permit": { "start": "string", "end": "string" }, "log": { "start": "string", "end": "string" }, "block": { "start": "string", "end": "string" } } } ] } }, "Services": { "title": "Services", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the services object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,63}$" }, "description": { "type": "string", "description": "Description of the services object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "block_message": { "type": "string", "description": "Block Message. Applicable only when service_type is SERVICE (not GROUP)." }, "service_type": { "type": "string", "description": "Type of the service object. When set to GROUP, only uuid, name, description, service references (group members), and hash_key are relevant; all other fields are ignored.. Allowed values: [SERVICE, GROUP]" }, "protocols": { "type": "array", "items": { "$ref": "#/components/schemas/Protocols" }, "description": "Service may consist of different protocol terms. Each term defines a protocol alg set of an application. Applicable only when service_type is SERVICE (not GROUP).. Max length: 8" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesServicesRef" }, "description": "Group members (self-reference). Applicable only when service_type is GROUP. When service_type is GROUP, only uuid, name, description, service references (group members), and hash_key are relevant; any other fields provided will be ignored." } }, "description": "service object", "example": { "uuid": "string", "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } }, "ServicesInput": { "title": "ServicesInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the services object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_]{0,63}$" }, "description": { "type": "string", "description": "Description of the services object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "block_message": { "type": "string", "description": "Block Message. Applicable only when service_type is SERVICE (not GROUP)." }, "service_type": { "type": "string", "description": "Type of the service object. When set to GROUP, only uuid, name, description, service references (group members), and hash_key are relevant; all other fields are ignored.. Allowed values: [SERVICE, GROUP]" }, "protocols": { "type": "array", "items": { "$ref": "#/components/schemas/Protocols" }, "description": "Service may consist of different protocol terms. Each term defines a protocol alg set of an application. Applicable only when service_type is SERVICE (not GROUP).. Max length: 8" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesServicesRef" }, "description": "Group members (self-reference). Applicable only when service_type is GROUP. When service_type is GROUP, only uuid, name, description, service references (group members), and hash_key are relevant; any other fields provided will be ignored." } }, "description": "service object", "example": { "name": "string", "description": "string", "block_message": "string", "service_type": "string", "protocols": [ { "protocol_name": "string", "protocol_description": "string", "alg": "string", "src_port": "string", "dst_port": "string", "disable_timeout": true, "inactivity_timeout": "string", "protocol_type": "string", "protocol_number": "string", "rpc_program_number": "string", "icmp_code": "string", "icmp_type": "string", "sun_rpc_protocol_type": "string", "ms_rpc_protocol_type": "string", "ms_rpc_uuid": "string" } ], "services": [ { "uuid": "string" } ] } }, "ServicesServicesRef": { "title": "ServicesServicesRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to Services", "example": { "uuid": "string" } }, "SignatureBasedMapping": { "title": "SignatureBasedMapping", "type": "object", "properties": { "protocol": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureMappingProtocol" }, "description": "list of protocols" } }, "description": "signature based mapping", "example": { "protocol": [ { "protocol_name": "string", "protocol": "string", "signature": [ { "signature_name": "string", "port_range": "string", "member": [ { "member_name": "string", "direction": "string", "pattern": "string", "context": "string" } ] } ] } ] } }, "SignatureMappingMember": { "title": "SignatureMappingMember", "required": [ "member_name", "direction", "pattern", "context" ], "type": "object", "properties": { "member_name": { "type": "string", "description": "Application signature member identifier in range m01 to m15" }, "direction": { "type": "string", "description": "direction for application flow" }, "pattern": { "type": "string", "description": "Patterns are to match information in the received packet" }, "context": { "type": "string", "description": "context to be matched" } }, "description": "Member details for signature based mapping", "example": { "member_name": "string", "direction": "string", "pattern": "string", "context": "string" } }, "SignatureMappingProtocol": { "title": "SignatureMappingProtocol", "type": "object", "properties": { "protocol_name": { "type": "string", "description": "unique name" }, "protocol": { "type": "string", "description": "Protocol that carry the given application" }, "signature": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureMappingSignature" }, "description": "list of signatures" } }, "description": "protocol details", "example": { "protocol_name": "string", "protocol": "string", "signature": [ { "signature_name": "string", "port_range": "string", "member": [ { "member_name": "string", "direction": "string", "pattern": "string", "context": "string" } ] } ] } }, "SignatureMappingSignature": { "title": "SignatureMappingSignature", "required": [ "signature_name" ], "type": "object", "properties": { "signature_name": { "type": "string", "description": "A unique application signature identifier" }, "port_range": { "type": "string", "description": "Port range" }, "member": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureMappingMember" }, "description": "list of members" } }, "description": "signature details", "example": { "signature_name": "string", "port_range": "string", "member": [ { "member_name": "string", "direction": "string", "pattern": "string", "context": "string" } ] } }, "URLCategoryList": { "title": "URLCategoryList", "required": [ "uuid", "name" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the object. Format: ^[a-zA-Z0-9:._-]{1,59}$" }, "description": { "type": "string", "description": "Description of the scheduler object" }, "url_patterns": { "type": "array", "items": { "$ref": "#/components/schemas/URLCategoryListURLPatternsRef" }, "description": "References to url-patterns" } }, "description": "url-categories object", "example": { "uuid": "string", "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } }, "URLCategoryListInput": { "title": "URLCategoryListInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the object. Format: ^[a-zA-Z0-9:._-]{1,59}$" }, "description": { "type": "string", "description": "Description of the scheduler object" }, "url_patterns": { "type": "array", "items": { "$ref": "#/components/schemas/URLCategoryListURLPatternsRef" }, "description": "References to url-patterns" } }, "description": "url-categories object", "example": { "name": "string", "description": "string", "url_patterns": [ { "uuid": "string" } ] } }, "URLCategoryListURLPatternsRef": { "title": "URLCategoryListURLPatternsRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to URLPatterns", "example": { "uuid": "string" } }, "URLPatterns": { "title": "URLPatterns", "required": [ "uuid", "name", "address_patterns" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the object, system automatically allocates one if not provided. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Name of the url-patterns object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*]{0,255}$" }, "address_patterns": { "type": "array", "items": { "type": "string" }, "description": "List of Address patterns. Each entry must be a valid IP address, URL or URL pattern supported by device.. Min length: 1" } }, "description": "url-patterns object", "example": { "uuid": "string", "name": "string", "description": "string", "address_patterns": [ "string" ] } }, "URLPatternsInput": { "title": "URLPatternsInput", "required": [ "name", "address_patterns" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the url-patterns object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*]{0,255}$" }, "address_patterns": { "type": "array", "items": { "type": "string" }, "description": "List of Address patterns. Each entry must be a valid IP address, URL or URL pattern supported by device.. Min length: 1" } }, "description": "url-patterns object", "example": { "name": "string", "description": "string", "address_patterns": [ "string" ] } }, "VariableAddressMap": { "title": "VariableAddressMap", "type": "object", "properties": { "device_uuid": { "type": "string", "description": "uuid of the device" }, "address_uuid": { "type": "string", "description": "address uuid for the device" } }, "description": "Contains map of devices and their address in variable address case", "example": { "device_uuid": "string", "address_uuid": "string" } }, "VariableZone": { "title": "VariableZone", "required": [ "uuid", "name", "type", "default_zone" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for the variable zone. System auto-generates if not provided. Example: '550e8400-e29b-41d4-a716-446655440000'. Format: ^[a-zA-Z0-9\\-_:+/=]{0,256}$", "readOnly": true }, "name": { "type": "string", "description": "Human-readable name for the variable zone. Must start with alphanumeric and can contain hyphens, underscores, dots, colons, or slashes. Example: 'datacenter-dmz-zones' or 'branch_office_variable_zone'. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{1,63}$" }, "description": { "type": "string", "description": "Optional free-text description of the variable zone's purpose and scope. Example: 'Variable zone for all DMZ segments across datacenter locations'. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "type": { "type": "string", "description": "Classification type for the variable zone. Currently only 'VARIABLE_ZONE' is supported. Example: 'VARIABLE_ZONE'. Allowed values: [VARIABLE_ZONE]" }, "default_zone": { "type": "string", "description": "The default zone name used when a device-specific mapping is not defined. This serves as the fallback value. Example: 'trust' or 'untrust'" }, "variable_zone_map": { "type": "array", "items": { "$ref": "#/components/schemas/VariableZoneMap" }, "description": "Array of device-to-zone mappings that override the default_zone for specific devices. Each entry maps a device identifier to its corresponding zone. Example: [{'device_id': 'srx-fw-01', 'zone': 'dmz'}, {'device_id': 'srx-fw-02', 'zone': 'internal'}]" }, "variable_zone": { "type": "array", "items": { "$ref": "#/components/schemas/VariableZoneVariableZoneRef" }, "description": "Self reference for zone set" } }, "description": "zone set object", "example": { "uuid": "string", "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } }, "VariableZoneInput": { "title": "VariableZoneInput", "required": [ "name", "type", "default_zone" ], "type": "object", "properties": { "name": { "type": "string", "description": "Human-readable name for the variable zone. Must start with alphanumeric and can contain hyphens, underscores, dots, colons, or slashes. Example: 'datacenter-dmz-zones' or 'branch_office_variable_zone'. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_.:/\\\\\\\\s]{1,63}$" }, "description": { "type": "string", "description": "Optional free-text description of the variable zone's purpose and scope. Example: 'Variable zone for all DMZ segments across datacenter locations'. Format: ^[a-zA-Z0-9][a-zA-Z0-9-._!\"'#%,:;=@{}~\\$\\(\\)\\*\\+\\/\\\\\\?\\[\\]\\^\\|\\s*][^&<>]{0,899}$" }, "type": { "type": "string", "description": "Classification type for the variable zone. Currently only 'VARIABLE_ZONE' is supported. Example: 'VARIABLE_ZONE'. Allowed values: [VARIABLE_ZONE]" }, "default_zone": { "type": "string", "description": "The default zone name used when a device-specific mapping is not defined. This serves as the fallback value. Example: 'trust' or 'untrust'" }, "variable_zone_map": { "type": "array", "items": { "$ref": "#/components/schemas/VariableZoneMap" }, "description": "Array of device-to-zone mappings that override the default_zone for specific devices. Each entry maps a device identifier to its corresponding zone. Example: [{'device_id': 'srx-fw-01', 'zone': 'dmz'}, {'device_id': 'srx-fw-02', 'zone': 'internal'}]" }, "variable_zone": { "type": "array", "items": { "$ref": "#/components/schemas/VariableZoneVariableZoneRef" }, "description": "Self reference for zone set" } }, "description": "zone set object", "example": { "name": "string", "description": "string", "type": "string", "default_zone": "string", "variable_zone_map": [ { "device_uuid": "string", "zone_uuid": "string" } ], "variable_zone": [ { "uuid": "string" } ] } }, "VariableZoneMap": { "title": "VariableZoneMap", "type": "object", "properties": { "device_uuid": { "type": "string", "description": "uuid of the device" }, "zone_uuid": { "type": "string", "description": "zone uuid for the device" } }, "description": "Contains map of devices and their zones in variable zone case", "example": { "device_uuid": "string", "zone_uuid": "string" } }, "VariableZoneVariableZoneRef": { "title": "VariableZoneVariableZoneRef", "type": "object", "properties": { "uuid": { "type": "string" } }, "description": "Reference to VariableZone", "example": { "uuid": "string" } }, "WebFilteringProfileInput": { "title": "WebFilteringProfileInput", "required": [ "name", "profile_type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the web-filtering-profile object. Format: ^[a-zA-Z0-9][a-zA-Z0-9-_@!#$%^*-+,.:/\\\\s]{0,28}$" }, "description": { "type": "string", "description": "Description of the object. Format: ^.{0,255}$" }, "profile_type": { "type": "string", "description": "Web filtering profile type. Allowed values: [WEBSENSE, LOCAL, JUNIPER_ENHANCED, NG_JUNIPER]" }, "port": { "type": "integer", "description": "Server port (1024..65535)", "format": "int32" }, "server": { "type": "string", "description": "Server host IP address or string host name" }, "account": { "type": "string", "description": "Websense redirect account" }, "timeout": { "type": "integer", "description": "Websense redirect timeout (1..1800 seconds)", "format": "int32" }, "sockets": { "type": "integer", "description": "Websense redirect sockets number (1..32)", "format": "int32" }, "safe_search": { "type": "boolean", "description": "perform safe-search for Juniper enhanced protocol", "default": false }, "default_action": { "type": "string", "description": "Default action. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, QUARANTINE, NONE]" }, "custom_block_message": { "type": "string", "description": "Juniper enhanced custom block message sent to HTTP client" }, "quarantine_custom_message": { "type": "string", "description": "Juniper enhanced quarantine custom message" }, "site_reputation_actions": { "$ref": "#/components/schemas/WebFilteringProfileSiteReputationActions" }, "url_category_action_list": { "type": "array", "items": { "$ref": "#/components/schemas/WFCategoryActionMapping" }, "description": "Category action mapping. List of category-list and the action to be taken." }, "fallback_settings": { "$ref": "#/components/schemas/WebFilteringProfileFallbackSettings" } }, "description": "web-filtering-profiles object", "example": { "name": "string", "description": "string", "profile_type": "string", "port": 1, "server": "string", "account": "string", "timeout": 1, "sockets": 1, "safe_search": true, "default_action": "string", "custom_block_message": "string", "quarantine_custom_message": "string", "site_reputation_actions": { "moderately_safe": "string", "harmful": "string", "suspicious": "string", "very_safe": "string", "fairly_safe": "string" }, "url_category_action_list": [ { "category_uuid": "string", "category_name": "string", "action": "string", "custom_message": "string", "redirect_profile_id": "string", "redirect_type": "string" } ], "fallback_settings": { "default": "string", "server_connectivity": "string", "timeout": "string", "too_many_requests": "string" } } }, "AntiVirusProfileFallbackDeny": { "title": "AntiVirusProfileFallbackDeny", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "type": "string", "description": "Virus detection notification type. Allowed values: [PROTOCOL, MESSAGE, NONE]" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "AntiVirusProfileFallbackNonDeny": { "title": "AntiVirusProfileFallbackNonDeny", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "AntiVirusProfileFallbackOptions": { "title": "AntiVirusProfileFallbackOptions", "type": "object", "properties": { "engine_error": { "type": "string", "description": "Fallback action for engine not ready. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "default_action": { "type": "string", "description": "Default action. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "timeout": { "type": "string", "description": "Fallback action for engine scan timeout. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "out_of_resources": { "type": "string", "description": "Fallback action for out of resources. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "too_many_requests": { "type": "string", "description": "Fallback action for requests exceed engine limit. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "decompress_error": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "content_size": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" } } }, "AntiVirusProfileInputFallbackDeny": { "title": "AntiVirusProfileInputFallbackDeny", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "type": "string", "description": "Virus detection notification type. Allowed values: [PROTOCOL, MESSAGE, NONE]" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "AntiVirusProfileInputFallbackNonDeny": { "title": "AntiVirusProfileInputFallbackNonDeny", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "AntiVirusProfileInputFallbackOptions": { "title": "AntiVirusProfileInputFallbackOptions", "type": "object", "properties": { "engine_error": { "type": "string", "description": "Fallback action for engine not ready. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "default_action": { "type": "string", "description": "Default action. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "timeout": { "type": "string", "description": "Fallback action for engine scan timeout. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "out_of_resources": { "type": "string", "description": "Fallback action for out of resources. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "too_many_requests": { "type": "string", "description": "Fallback action for requests exceed engine limit. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "decompress_error": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" }, "content_size": { "type": "string", "description": "Fallback action for decompress error. Allowed values: [PERMIT, LOG_AND_PERMIT, BLOCK, NONE]" } } }, "AntiVirusProfileInputScanOptions": { "title": "AntiVirusProfileInputScanOptions", "type": "object", "properties": { "content_size_limit": { "type": "integer", "description": "content size limit in kilobytes (KB). The limit range is 20-40,000 KB", "format": "int32" } } }, "AntiVirusProfileInputVirusDetectionNotificationOptions": { "title": "AntiVirusProfileInputVirusDetectionNotificationOptions", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "type": "string", "description": "Virus detection notification type. Allowed values: [PROTOCOL, MESSAGE, NONE]" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "AntiVirusProfileScanOptions": { "title": "AntiVirusProfileScanOptions", "type": "object", "properties": { "content_size_limit": { "type": "integer", "description": "content size limit in kilobytes (KB). The limit range is 20-40,000 KB", "format": "int32" } } }, "AntiVirusProfileVirusDetectionNotificationOptions": { "title": "AntiVirusProfileVirusDetectionNotificationOptions", "type": "object", "properties": { "custom_notification_message": { "type": "string", "description": "Custom message for notification" }, "notification_type": { "type": "string", "description": "Virus detection notification type. Allowed values: [PROTOCOL, MESSAGE, NONE]" }, "custom_notification_subject": { "type": "string", "description": "Custom message subject for notification" }, "notify_mail_sender": { "type": "boolean", "description": "Notify mail sender if set to true; else, don't notify" } } }, "ApplicationApplicationMapping": { "title": "ApplicationApplicationMapping", "type": "object", "properties": { "icmp_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIcmpBased" }, "ip_protocol_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIpProtocolBased" }, "address_based": { "$ref": "#/components/schemas/ApplicationMappingObjectAddressBased" }, "signature_based": { "$ref": "#/components/schemas/ApplicationMappingObjectSignatureBased" } } }, "ApplicationInputApplicationMapping": { "title": "ApplicationInputApplicationMapping", "type": "object", "properties": { "icmp_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIcmpBased" }, "ip_protocol_based": { "$ref": "#/components/schemas/ApplicationMappingObjectIpProtocolBased" }, "address_based": { "$ref": "#/components/schemas/ApplicationMappingObjectAddressBased" }, "signature_based": { "$ref": "#/components/schemas/ApplicationMappingObjectSignatureBased" } } }, "ApplicationMappingObjectAddressBased": { "title": "ApplicationMappingObjectAddressBased", "type": "object", "properties": { "address_list": { "type": "array", "items": { "$ref": "#/components/schemas/AddressMappingContent" }, "description": "list of address based mappings" } } }, "ApplicationMappingObjectIcmpBased": { "title": "ApplicationMappingObjectIcmpBased", "type": "object", "properties": { "icmp_code": { "type": "integer", "description": "icmp code to be matched", "format": "int32" }, "icmp_type": { "type": "integer", "description": "icmp type to be matched", "format": "int32" } } }, "ApplicationMappingObjectIpProtocolBased": { "title": "ApplicationMappingObjectIpProtocolBased", "type": "object", "properties": { "ip_protocol": { "type": "integer", "description": "protocol to be matched", "format": "int32" } } }, "ApplicationMappingObjectSignatureBased": { "title": "ApplicationMappingObjectSignatureBased", "type": "object", "properties": { "protocol": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureMappingProtocol" }, "description": "list of protocols" } } }, "DestinationOptionsHome-address-option": { "title": "DestinationOptionsHome-address-option", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "DestinationOptionsOption-type": { "title": "DestinationOptionsOption-type", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "ExtensionHeaderDestination-options": { "title": "ExtensionHeaderDestination-options", "type": "object", "properties": { "home-address-option": { "$ref": "#/components/schemas/DestinationOptionsHome-address-option" }, "option-type": { "$ref": "#/components/schemas/DestinationOptionsOption-type" } } }, "ExtensionHeaderRouting-header": { "title": "ExtensionHeaderRouting-header", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IcapProfileFallbackOptions": { "title": "IcapProfileFallbackOptions", "type": "object", "properties": { "timeout_action": { "type": "string", "description": "request a valid timeout option. Allowed values: [none, permit, log_permit, block]" }, "connectivity_failure_action": { "type": "string", "description": "select a valid connectivity action. Allowed values: [none, permit, log_permit, block]" }, "default_failure_action": { "type": "string", "description": "select a default option other than timeout and connectivity failure issues.. Allowed values: [none, permit, log_permit, block]" } } }, "IcapProfileInputFallbackOptions": { "title": "IcapProfileInputFallbackOptions", "type": "object", "properties": { "timeout_action": { "type": "string", "description": "request a valid timeout option. Allowed values: [none, permit, log_permit, block]" }, "connectivity_failure_action": { "type": "string", "description": "select a valid connectivity action. Allowed values: [none, permit, log_permit, block]" }, "default_failure_action": { "type": "string", "description": "select a default option other than timeout and connectivity failure issues.. Allowed values: [none, permit, log_permit, block]" } } }, "IcapServerInputSslInitiationProfile": { "title": "IcapServerInputSslInitiationProfile", "type": "object", "properties": { "ssli_profile_uuid": { "type": "string", "description": "UUID of the ssl initiation profile" }, "ssli_profile_name": { "type": "string", "description": "Name of the ssl initiation profile" } } }, "IcapServerSslInitiationProfile": { "title": "IcapServerSslInitiationProfile", "type": "object", "properties": { "ssli_profile_uuid": { "type": "string", "description": "UUID of the ssl initiation profile" }, "ssli_profile_name": { "type": "string", "description": "Name of the ssl initiation profile" } } }, "IPSProtocolParametersIpv4": { "title": "IPSProtocolParametersIpv4", "type": "object", "properties": { "checksum-validate": { "$ref": "#/components/schemas/IPV4ProtocolParametersChecksum-validate" }, "destination": { "$ref": "#/components/schemas/IPV4ProtocolParametersDestination" }, "identification": { "$ref": "#/components/schemas/IPV4ProtocolParametersIdentification" }, "ihl": { "$ref": "#/components/schemas/IPV4ProtocolParametersIhl" }, "ip-flags": { "$ref": "#/components/schemas/IPV4ProtocolParametersIp-flags" }, "protocol": { "$ref": "#/components/schemas/IPV4ProtocolParametersProtocol" }, "source": { "$ref": "#/components/schemas/IPV4ProtocolParametersSource" }, "tos": { "$ref": "#/components/schemas/IPV4ProtocolParametersTos" }, "total-length": { "$ref": "#/components/schemas/IPV4ProtocolParametersTotal-length" }, "ttl": { "$ref": "#/components/schemas/IPV4ProtocolParametersTtl" } } }, "IPSProtocolParametersIpv6": { "title": "IPSProtocolParametersIpv6", "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/IPV6ProtocolParametersDestination" }, "extension-header": { "$ref": "#/components/schemas/IPV6ProtocolParametersExtension-header" }, "flow-label": { "$ref": "#/components/schemas/IPV6ProtocolParametersFlow-label" }, "hop-limit": { "$ref": "#/components/schemas/IPV6ProtocolParametersHop-limit" }, "next-header": { "$ref": "#/components/schemas/IPV6ProtocolParametersNext-header" }, "payload-length": { "$ref": "#/components/schemas/IPV6ProtocolParametersPayload-length" }, "source": { "$ref": "#/components/schemas/IPV6ProtocolParametersSource" }, "traffic-class": { "$ref": "#/components/schemas/IPV6ProtocolParametersTraffic-class" } } }, "IPV4ProtocolParametersChecksum-validate": { "title": "IPV4ProtocolParametersChecksum-validate", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersDestination": { "title": "IPV4ProtocolParametersDestination", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersIdentification": { "title": "IPV4ProtocolParametersIdentification", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersIhl": { "title": "IPV4ProtocolParametersIhl", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersIp-flags": { "title": "IPV4ProtocolParametersIp-flags", "type": "object", "properties": { "df": { "type": "boolean", "description": "Don't Fragment bit", "default": false }, "mf": { "type": "boolean", "description": "More Fragment bit", "default": false }, "rb": { "type": "boolean", "description": "Reserved bit", "default": false }, "no-df": { "type": "boolean", "description": "Don't set Don't Fragment bit", "default": false }, "no-mf": { "type": "boolean", "description": "Don't set More Fragment bit", "default": false }, "no-rb": { "type": "boolean", "description": "Don't set Reserved bit", "default": false } } }, "IPV4ProtocolParametersProtocol": { "title": "IPV4ProtocolParametersProtocol", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersSource": { "title": "IPV4ProtocolParametersSource", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersTos": { "title": "IPV4ProtocolParametersTos", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersTotal-length": { "title": "IPV4ProtocolParametersTotal-length", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV4ProtocolParametersTtl": { "title": "IPV4ProtocolParametersTtl", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersDestination": { "title": "IPV6ProtocolParametersDestination", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersExtension-header": { "title": "IPV6ProtocolParametersExtension-header", "type": "object", "properties": { "routing-header": { "$ref": "#/components/schemas/ExtensionHeaderRouting-header" }, "destination-options": { "$ref": "#/components/schemas/ExtensionHeaderDestination-options" } } }, "IPV6ProtocolParametersFlow-label": { "title": "IPV6ProtocolParametersFlow-label", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersHop-limit": { "title": "IPV6ProtocolParametersHop-limit", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersNext-header": { "title": "IPV6ProtocolParametersNext-header", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersPayload-length": { "title": "IPV6ProtocolParametersPayload-length", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersSource": { "title": "IPV6ProtocolParametersSource", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "IPV6ProtocolParametersTraffic-class": { "title": "IPV6ProtocolParametersTraffic-class", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the match value. Allowed values: [EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL]" }, "value": { "type": "string", "description": "Value of the match value" } } }, "PatternSetContentProtocolParameters": { "title": "PatternSetContentProtocolParameters", "type": "object", "properties": { "IPV6": { "$ref": "#/components/schemas/IPSProtocolParametersIpv6" }, "IPV4": { "$ref": "#/components/schemas/IPSProtocolParametersIpv4" } } }, "SchedulerInputSchedules": { "title": "SchedulerInputSchedules", "type": "object", "properties": { "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinition" }, "description": "Contains the schedule definition of the day" } } }, "SchedulerSchedules2": { "title": "SchedulerSchedules2", "type": "object", "properties": { "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDefinition" }, "description": "Contains the schedule definition of the day" } } }, "BulkMoveFirewallPolicyRulesInputPolicyScope": { "title": "BulkMoveFirewallPolicyRulesInputPolicyScope", "enum": [ "POLICY_SCOPE_UNSPECIFIED", "GLOBAL", "ZONE" ], "type": "string", "example": "POLICY_SCOPE_UNSPECIFIED" }, "ObjectInfoContentApplicationObjectTypeApplicationEnum": { "title": "ObjectInfoContentApplicationObjectTypeApplicationEnum", "enum": [ "APPLICATION", "SERVICE" ], "type": "string", "description": "Allowed object types for applications.\n\n - APPLICATION: Application object type\n - SERVICE: Service object type", "example": "APPLICATION" }, "apiAction": { "title": "apiAction", "enum": [ "DENY", "PERMIT", "REJECT", "TUNNEL", "REDIRECT" ], "type": "string", "description": "Action to be taken when a rule matches.\n\n - DENY: Deny action\n - PERMIT: Permit action\n - REJECT: Reject action\n - TUNNEL: Tunnel action\n - REDIRECT: Redirect action", "example": "DENY" }, "AddressReference": { "title": "AddressReference", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Address object UUID." }, "name": { "type": "string", "description": "Address object name. Populated by the server on read responses.", "readOnly": true } }, "description": "AddressReference identifies an address endpoint.", "example": { "uuid": "string", "name": "string" } }, "AssignmentTarget": { "title": "AssignmentTarget", "required": [ "target_uuid", "target_type" ], "type": "object", "properties": { "target_uuid": { "type": "string", "description": "Device UUID to assign to the policy" }, "target_type": { "$ref": "#/components/schemas/apiTargetType" } }, "example": { "target_uuid": "string", "target_type": "DEVICE" } }, "BatchFirewallPoliciesMappingDevicesInput": { "title": "BatchFirewallPoliciesMappingDevicesInput", "type": "object", "properties": { "force_unassign": { "type": "boolean" }, "assign": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentTarget" }, "description": "List of devices to assign to the policy" }, "unassign": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentTarget" }, "description": "List of devices to unassign from the policy" } }, "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } }, "BatchFirewallPoliciesMappingDevicesResponse": { "title": "BatchFirewallPoliciesMappingDevicesResponse", "type": "object", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentStatus" }, "description": "List of assignment results" } }, "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } }, "BulkMoveFirewallPolicyRulesInput": { "title": "BulkMoveFirewallPolicyRulesInput", "required": [ "rule_uuids", "position", "target_scope" ], "type": "object", "properties": { "rule_uuids": { "type": "array", "items": { "type": "string" }, "description": "List of firewall rule UUIDs to be moved. Cannot be empty." }, "target_rule_group_id": { "type": "string", "description": "(Optional) Target rule group UUID for moving the rules. If not specified, the rules will be moved within their target_scope." }, "position": { "type": "integer", "description": "When target_rule_group_id is set: 0 = before the reference rule, 1 = after the reference rule. When target_rule_group_id is absent: absolute 0-based target position within the rule group.", "format": "int32" }, "target_scope": { "allOf": [ { "$ref": "#/components/schemas/BulkMoveFirewallPolicyRulesInputPolicyScope" }, { "example": "POLICY_SCOPE_UNSPECIFIED" } ] } }, "description": "Input to move one or more firewall policy rules to a different position within the policy scope", "example": { "rule_uuids": [ "string" ], "target_rule_group_id": "string", "position": 1, "target_scope": "POLICY_SCOPE_UNSPECIFIED" } }, "apiCleanupMode": { "title": "apiCleanupMode", "enum": [ "STRICT", "IGNORE_UNDEPLOY_FAILURES", "SKIP_UNDEPLOY" ], "type": "string", "description": "Cleanup mode for policy removal operations.\n\n - STRICT: Undeploy from all devices first. Only remove assignments and policy if all undeploys succeed. If any device undeploy fails, entire cleanup fails (default)\n - IGNORE_UNDEPLOY_FAILURES: Attempt undeploy from all devices. Remove assignments and policy regardless of undeploy success/failure.\n - SKIP_UNDEPLOY: Skip device undeploy entirely. Directly remove all assignments and policy from system (metadata cleanup only).", "example": "STRICT" }, "CleanupMultiplePoliciesRequest": { "title": "CleanupMultiplePoliciesRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyEntry" }, "description": "List of policies to cleanup" }, "cleanup_mode": { "$ref": "#/components/schemas/apiCleanupMode" } }, "description": "Request to cleanup multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ], "cleanup_mode": "STRICT" } }, "CleanupPolicyInput": { "title": "CleanupPolicyInput", "type": "object", "properties": { "cleanup_mode": { "$ref": "#/components/schemas/apiCleanupMode" } }, "description": "Input message for cleanup operations (body only — no path params)", "example": { "cleanup_mode": "STRICT" } }, "CleanupPolicyResponse": { "title": "CleanupPolicyResponse", "type": "object", "properties": { "cleanup_id": { "type": "string", "description": "Unique cleanup operation ID for tracking", "readOnly": true } }, "description": "Response for cleanup operations", "example": { "cleanup_id": "string" } }, "CreateFirewallPoliciesRpcRequest": { "title": "CreateFirewallPoliciesRpcRequest", "required": [ "name", "order" ], "type": "object", "properties": { "name": { "type": "string", "description": "Policy name" }, "all_site_policy": { "type": "boolean", "description": "Flag to indicate if the policy is auto-assigned to all devices. When set to true, the policy will be dynamically assigned to all existing and future devices. No need to explicitly assign the policy to each device. When set to false, the policy needs to be explicitly assigned to devices. This property can not be changed once created. Default value is false.", "default": false }, "description": { "type": "string", "description": "Policy description." }, "order": { "type": "integer", "description": "Order of policy. Order starts from 1 any order beyond the current list size will be placed at the end of the list. 0 and negative order value not allowed.", "format": "int64" } }, "description": "Request to create a new firewall policy", "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } }, "DeployMultiplePoliciesRequest": { "title": "DeployMultiplePoliciesRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyEntry" }, "description": "List of policies to deploy" } }, "description": "Request to deploy multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL" } ] } }, "DeployPolicyResponse": { "title": "DeployPolicyResponse", "type": "object", "properties": { "deploy_id": { "type": "string", "description": "Unique deploy operation ID for tracking", "readOnly": true } }, "description": "Response for deploy operations", "example": { "deploy_id": "string" } }, "apiDeploymentStatus": { "title": "apiDeploymentStatus", "enum": [ "DEPLOY_STATUS_UNKNOWN", "PENDING", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED" ], "type": "string", "description": "Overall deployment status of an operation.\n\n - DEPLOY_STATUS_UNKNOWN: Unknown deployment status\n - PENDING: Deployment initiated, not yet started\n - IN_PROGRESS: Deployment in progress\n - COMPLETED: All devices completed successfully\n - PARTIAL_SUCCESS: Some devices succeeded, some failed\n - FAILED: All devices failed", "example": "DEPLOY_STATUS_UNKNOWN" }, "apiDeviceDeploymentState": { "title": "apiDeviceDeploymentState", "enum": [ "DEVICE_STATE_UNSPECIFIED", "DEVICE_STATE_DEPLOY_PENDING", "DEVICE_STATE_DEPLOYED", "DEVICE_STATE_REDEPLOY_REQUIRED", "DEVICE_STATE_UNDEPLOY_PENDING" ], "type": "string", "description": "DeviceDeploymentState represents the deployment state of a policy on a specific device.\n\n - DEVICE_STATE_UNSPECIFIED: Default/unknown state\n - DEVICE_STATE_DEPLOY_PENDING: Policy not deployed to this device\n - DEVICE_STATE_DEPLOYED: Policy successfully deployed to this device\n - DEVICE_STATE_REDEPLOY_REQUIRED: Policy changes require redeployment on this device\n - DEVICE_STATE_UNDEPLOY_PENDING: Policy is unassigned from this device, but not undeployed from this device", "example": "DEVICE_STATE_UNSPECIFIED" }, "apiDeviceDeploymentStatus": { "title": "apiDeviceDeploymentStatus", "enum": [ "DEVICE_STATUS_UNKNOWN", "DEVICE_STATUS_IN_PROGRESS", "DEVICE_STATUS_COMPLETED", "DEVICE_STATUS_FAILED", "DEVICE_STATUS_PENDING", "DEVICE_STATUS_SKIPPED", "DEVICE_STATUS_IGNORED_FAILURE" ], "type": "string", "description": "Deployment status of a policy on a specific device.\n\n - DEVICE_STATUS_UNKNOWN: Unknown device deployment status\n - DEVICE_STATUS_IN_PROGRESS: Device deployment in progress\n - DEVICE_STATUS_COMPLETED: Device deployment completed successfully\n - DEVICE_STATUS_FAILED: Device deployment failed\n - DEVICE_STATUS_PENDING: Device deployment not yet started\n - DEVICE_STATUS_SKIPPED: Device deployment skipped if specified in cleanup request\n - DEVICE_STATUS_IGNORED_FAILURE: Device deployment failed, but was ignored if specified in cleanup request", "example": "DEVICE_STATUS_UNKNOWN" }, "DeviceDeploymentStatusEntry": { "title": "DeviceDeploymentStatusEntry", "type": "object", "properties": { "device_id": { "type": "string", "description": "Device ID" }, "device_name": { "type": "string", "description": "Device name/hostname" }, "status": { "$ref": "#/components/schemas/apiDeviceDeploymentStatus" }, "message": { "type": "string", "description": "Status message" } }, "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } }, "DeviceStateDetail": { "title": "DeviceStateDetail", "type": "object", "properties": { "device_uuid": { "type": "string", "description": "The unique identifier of the device." }, "device_deploy_state": { "$ref": "#/components/schemas/apiDeviceDeploymentState" }, "description": { "type": "string", "description": "Description providing additional context about the device state." } }, "description": "Deployment state of a firewall policy on a specific device", "example": { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } }, "FirewallPoliciesInput": { "title": "FirewallPoliciesInput", "required": [ "name", "order" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Policy." }, "all_site_policy": { "type": "boolean", "description": "Flag to indicate if the policy is auto-assigned to all devices. When set to true, the policy will be dynamically assigned to all existing and future devices. No need to explicitly assign the policy to each device. When set to false, the policy needs to be explicitly assigned to devices. This property can not be changed once created. Default value is false.", "default": false }, "description": { "type": "string", "description": "Policy description." }, "order": { "type": "integer", "description": "Order of policy. Order starts from 1 any order beyond the current list size will be placed at the end of the list. 0 and negative order value not allowed.", "format": "int64" } }, "description": "Writable fields for creating or updating a firewall policy", "example": { "name": "string", "all_site_policy": true, "description": "string", "order": 1 } }, "FirewallPolicyMappingDeviceOutput": { "title": "FirewallPolicyMappingDeviceOutput", "type": "object", "properties": { "target_uuid": { "type": "string", "description": "Target UUID : Device UUID" }, "target_type": { "$ref": "#/components/schemas/apiTargetType" } }, "description": "Output structure for firewall policy device assignment operations", "example": { "target_uuid": "string", "target_type": "DEVICE" } }, "FirewallPolicyOutput": { "title": "FirewallPolicyOutput", "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique identifier for the firewall policy." }, "name": { "type": "string", "description": "Policy name." }, "all_site_policy": { "type": "boolean", "description": "Flag to indicate if the policy is auto-assigned to all devices. When set to true, the policy will be dynamically assigned to all existing and future devices. No need to explicitly assign the policy to each device. When set to false, the policy needs to be explicitly assigned to devices. Default value is false.", "default": false }, "description": { "type": "string", "description": "Policy description." }, "order": { "type": "integer", "description": "Order of policy. Order starts from 1 any order beyond the current list size will be placed at the end of the list. 0 and negative order value not allowed.", "format": "int64" } }, "example": { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } }, "FirewallPolicyRule": { "title": "FirewallPolicyRule", "type": "object", "properties": { "uuid": { "type": "string", "description": "Rule UUID." }, "name": { "type": "string", "description": "Rule name." }, "description": { "type": "string", "description": "Rule description." }, "group_uuid": { "type": "string", "description": "rule group UUID containing the rule" }, "action": { "$ref": "#/components/schemas/apiAction" }, "sources": { "$ref": "#/components/schemas/FirewallPolicyRuleSources" }, "destinations": { "$ref": "#/components/schemas/FirewallPolicyRuleDestinations" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectInfoContentApplication" }, "description": "Includes applications or service object" }, "options": { "$ref": "#/components/schemas/FirewallPolicyRuleOptions" }, "advanced_security": { "$ref": "#/components/schemas/FirewallPolicyRuleAdvancedSecurity" }, "ipsec_vpn": { "type": "string", "description": "Ipsec VPN for tunnel action - IpsecVpn name" }, "disabled": { "type": "boolean", "description": "disabled in create request", "default": false }, "sequence_number": { "type": "integer", "description": "Absolute 1-based index of the rule across the entire policy. This is computed by server while processing the list and hence returned only in list responses; never set by the caller.", "format": "int64" }, "scope": { "type": "string", "description": "Scope of rule or group: 'global' or 'zone'." } }, "example": { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } }, "FirewallPolicyRuleGroupInput": { "title": "FirewallPolicyRuleGroupInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule group name" }, "description": { "type": "string", "description": "Rule group description" }, "position": { "type": "integer", "description": "Position of rule group in the parent policy. Position starts from 0.", "format": "int64" } }, "description": "Writable fields for creating or updating a firewall policy rule group", "example": { "name": "string", "description": "string", "position": 1 } }, "FirewallPolicyRuleGroupOutput": { "title": "FirewallPolicyRuleGroupOutput", "type": "object", "properties": { "uuid": { "type": "string", "description": "Rule UUID" }, "group_uuid": { "type": "string", "description": "Parent group UUID" }, "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating the object. This is ignored for update and returned only while listing the rule tree.", "format": "int64" } }, "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } }, "FirewallPolicyRuleInput": { "title": "FirewallPolicyRuleInput", "required": [ "name", "action", "sources", "destinations", "applications" ], "type": "object", "properties": { "name": { "type": "string", "description": "Rule name." }, "description": { "type": "string", "description": "Rule description." }, "action": { "$ref": "#/components/schemas/apiAction" }, "sources": { "$ref": "#/components/schemas/FirewallPolicyRuleInputSources" }, "destinations": { "$ref": "#/components/schemas/FirewallPolicyRuleInputDestinations" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectInfoContentApplication" }, "description": "Includes applications or service object" }, "options": { "$ref": "#/components/schemas/FirewallPolicyRuleInputOptions" }, "advanced_security": { "$ref": "#/components/schemas/FirewallPolicyRuleInputAdvancedSecurity" }, "ipsec_vpn": { "type": "string", "description": "Ipsec VPN for tunnel action - IpsecVpn name" }, "disabled": { "type": "boolean", "description": "disabled in create request", "default": false }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating or moving rules within a group. This is ignored for update and returned only while listing the rule tree.", "format": "int64" } }, "example": { "name": "string", "description": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "position": 1 } }, "FirewallPolicyRuleTree": { "title": "FirewallPolicyRuleTree", "type": "object", "properties": { "uuid": { "type": "string", "description": "Rule UUID" }, "group_uuid": { "type": "string", "description": "Parent group UUID. For top-level rules directly under the policy, this field is 'GLOBAL_SCOPE' or 'ZONE_SCOPE' depending on the rule scope." }, "name": { "type": "string", "description": "Rule name" }, "description": { "type": "string", "description": "Rule description" }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating or moving rules. This is ignored for update and returned only while listing the rule tree.", "format": "int64" }, "sequence_number": { "type": "integer", "description": "Absolute 1-based index of the rule across the entire policy. This is computed by server while processing the list and hence returned only in list responses; never set by the caller.", "format": "int64" }, "type": { "type": "string", "description": "Type of this item, either 'rule' or 'group'." }, "scope": { "type": "string", "description": "Scope of rule or group: 'global' or 'zone'." } }, "example": { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1, "sequence_number": 1, "type": "string", "scope": "string" } }, "FirewallPolicyHeirarchyOutput": { "title": "FirewallPolicyHeirarchyOutput", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallPolicyRuleTree" }, "description": "List of rules and rule groups heirarchy in flat structure" }, "count": { "type": "integer", "description": "Total count of rules in the tree structure", "format": "int64" } }, "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1, "sequence_number": 1, "type": "string", "scope": "string" } ], "count": 1 } }, "FirewallRulesPolicyRuleOptions": { "title": "FirewallRulesPolicyRuleOptions", "type": "object", "properties": { "logging": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsLogging2" }, "scheduler": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsScheduler" }, "redirect_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsRedirectProfile" }, "policy_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsPolicyProfile" }, "counter": { "allOf": [ { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsCounter" }, { "example": { "enable": true } } ] } }, "description": "Advanced configuration options for firewall policy rules", "example": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } } }, "FirewallRulesPolicyRuleOptionsCounter": { "title": "FirewallRulesPolicyRuleOptionsCounter", "type": "object", "properties": { "enable": { "type": "boolean", "description": "Enable.", "default": false } }, "example": { "enable": true } }, "FirewallRulesPolicyRuleOptionsLogging": { "title": "FirewallRulesPolicyRuleOptionsLogging", "type": "object", "properties": { "session_initiate_log": { "type": "boolean", "description": "Enable logging when a session is initiated", "default": false }, "session_close_log": { "type": "boolean", "description": "Enable logging when a session is closed", "default": false } }, "description": "Logging configuration for firewall policy rules", "example": { "session_initiate_log": true, "session_close_log": true } }, "GetFirewallPolicyRuleGroupOutput": { "title": "GetFirewallPolicyRuleGroupOutput", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallPolicyRuleGroupOutput" }, "description": "List of rules" }, "count": { "type": "integer", "description": "Total count of rule groups matching the query", "format": "int64" } }, "example": { "items": [ { "uuid": "string", "group_uuid": "string", "name": "string", "description": "string", "position": 1 } ], "count": 1 } }, "GetFirewallPolicyRuleOutput": { "title": "GetFirewallPolicyRuleOutput", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallPolicyRule" }, "description": "List of rules" }, "count": { "type": "integer", "description": "Total count of rules matching the query", "format": "int64" } }, "example": { "items": [ { "uuid": "string", "name": "string", "description": "string", "group_uuid": "string", "action": "DENY", "sources": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "destinations": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true }, "applications": [ { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } ], "options": { "logging": { "session_initiate_log": true, "session_close_log": true }, "scheduler": { "uuid": "string", "name": "string" }, "redirect_profile": { "uuid": "string", "name": "string" }, "policy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "counter": { "enable": true } }, "advanced_security": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } }, "ipsec_vpn": "string", "disabled": true, "sequence_number": 1, "scope": "string" } ], "count": 1 } }, "GetFirewallPolicyStateResponse": { "title": "GetFirewallPolicyStateResponse", "type": "object", "properties": { "policy_state": { "$ref": "#/components/schemas/apiPolicyDeploymentState" }, "all_device_policy": { "type": "boolean", "description": "Is the policy an all device policy - All devices are implicitly assigned", "default": false }, "assigned_devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceStateDetail" }, "description": "List of assigned devices and their deployment states." } }, "description": "Deployment state of a firewall policy, including per-device deployment details", "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } }, "GetPolicyCleanupResultByDeviceResponse": { "title": "GetPolicyCleanupResultByDeviceResponse", "type": "object", "properties": { "device_id": { "type": "string", "description": "Device UUID", "readOnly": true }, "device_name": { "type": "string", "description": "Device name/hostname", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeviceDeploymentStatus" }, "deployed_config": { "type": "string", "description": "Configuration that was removed from the device (empty after cleanup). Format matches the requested format parameter (CLI or XML).", "readOnly": true }, "format": { "type": "string", "description": "Configuration format (XML or CLI)", "readOnly": true }, "message": { "type": "string", "description": "Device-specific status message", "readOnly": true } }, "description": "Response containing cleanup result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } }, "GetPolicyCleanupStatusResponse": { "title": "GetPolicyCleanupStatusResponse", "type": "object", "properties": { "cleanup_id": { "type": "string", "description": "Cleanup operation ID", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeploymentStatus" }, "device_deployment_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDeploymentStatusEntry" }, "description": "Device-level cleanup results (SUCCESS/FAILED for entire config removal from each device)" }, "message": { "type": "string", "description": "Overall status message", "readOnly": true } }, "description": "Response containing cleanup operation status", "example": { "cleanup_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } }, "GetPolicyDeployResultByDeviceResponse": { "title": "GetPolicyDeployResultByDeviceResponse", "type": "object", "properties": { "device_id": { "type": "string", "description": "Device UUID", "readOnly": true }, "device_name": { "type": "string", "description": "Device name/hostname", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeviceDeploymentStatus" }, "deployed_config": { "type": "string", "description": "Configuration that was deployed on the device. Format matches the requested format parameter (CLI or XML).", "readOnly": true }, "format": { "type": "string", "description": "Configuration format (XML or CLI)", "readOnly": true }, "message": { "type": "string", "description": "Device-specific status message", "readOnly": true } }, "description": "Response containing deploy result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } }, "GetPolicyDeployStatusResponse": { "title": "GetPolicyDeployStatusResponse", "type": "object", "properties": { "deploy_id": { "type": "string", "description": "Deploy operation ID", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeploymentStatus" }, "device_deployment_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDeploymentStatusEntry" }, "description": "Device-level deploy results (SUCCESS/FAILED for entire config sync to each device)" }, "message": { "type": "string", "description": "Overall status message", "readOnly": true } }, "description": "Response containing deploy operation status", "example": { "deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } }, "GetPolicyPreviewResultByDeviceResponse": { "title": "GetPolicyPreviewResultByDeviceResponse", "type": "object", "properties": { "device_id": { "type": "string", "description": "Device UUID", "readOnly": true }, "device_name": { "type": "string", "description": "Device name/hostname", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeviceDeploymentStatus" }, "config_diff": { "type": "string", "description": "Configuration diff/preview showing what would be deployed. Format matches the requested format parameter (CLI or XML).", "readOnly": true }, "format": { "type": "string", "description": "Configuration format (XML or CLI)", "readOnly": true }, "message": { "type": "string", "description": "Device-specific status message", "readOnly": true } }, "description": "Response containing preview result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "config_diff": "string", "format": "string", "message": "string" } }, "GetPolicyPreviewStatusResponse": { "title": "GetPolicyPreviewStatusResponse", "type": "object", "properties": { "preview_id": { "type": "string", "description": "Preview ID", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeploymentStatus" }, "device_deployment_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDeploymentStatusEntry" }, "description": "Device-level preview results (SUCCESS/FAILED for entire config)" }, "message": { "type": "string", "description": "Overall status message", "readOnly": true } }, "description": "Response containing preview status", "example": { "preview_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } }, "GetPolicySelectiveDeployResultByDeviceResponse": { "title": "GetPolicySelectiveDeployResultByDeviceResponse", "type": "object", "properties": { "device_id": { "type": "string", "description": "Device UUID", "readOnly": true }, "device_name": { "type": "string", "description": "Device name/hostname", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeviceDeploymentStatus" }, "deployed_config": { "type": "string", "description": "Deployed configuration that was pushed to the device. Format matches the requested format parameter (CLI or XML).", "readOnly": true }, "format": { "type": "string", "description": "Configuration format (XML or CLI)", "readOnly": true }, "message": { "type": "string", "description": "Device-specific status message", "readOnly": true } }, "description": "Response containing selective deploy result for a specific device", "example": { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "deployed_config": "string", "format": "string", "message": "string" } }, "GetPolicySelectiveDeployStatusResponse": { "title": "GetPolicySelectiveDeployStatusResponse", "type": "object", "properties": { "selective_deploy_id": { "type": "string", "description": "Selective deploy operation ID", "readOnly": true }, "status": { "$ref": "#/components/schemas/apiDeploymentStatus" }, "device_deployment_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDeploymentStatusEntry" }, "description": "Device-level deployment results (SUCCESS/FAILED for entire config push to each device)" }, "message": { "type": "string", "description": "Overall status message", "readOnly": true } }, "description": "Response containing selective deploy operation status", "example": { "selective_deploy_id": "string", "status": "DEPLOY_STATUS_UNKNOWN", "device_deployment_status": [ { "device_id": "string", "device_name": "string", "status": "DEVICE_STATUS_UNKNOWN", "message": "string" } ], "message": "string" } }, "IdentityReference": { "title": "IdentityReference", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Identity (user) object UUID." }, "name": { "type": "string", "description": "Identity object name. Populated by the server on read responses.", "readOnly": true } }, "description": "IdentityReference identifies a user/identity endpoint (source only).", "example": { "uuid": "string", "name": "string" } }, "InheritableObjectReference": { "title": "InheritableObjectReference", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } }, "description": "Reference to a shared object that supports inheritance from the policy profile.", "example": { "inherited": true, "uuid": "string", "name": "string" } }, "ListFirewallPoliciesMappingDevicesResponse": { "title": "ListFirewallPoliciesMappingDevicesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallPolicyMappingDeviceOutput" }, "description": "List of assigned devices" }, "count": { "type": "integer", "description": "Total count of device assignments matching the query", "format": "int64" } }, "description": "Response containing a list of firewall policy device assignments", "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } }, "ListFirewallPoliciesResponse": { "title": "ListFirewallPoliciesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FirewallPolicyOutput" }, "description": "Items represents list of external-facing firewall policies model" }, "count": { "type": "integer", "description": "Total count of policies matching the query", "format": "int64" } }, "description": "Response containing a list of firewall policies, including total count matching the query", "example": { "items": [ { "uuid": "string", "name": "string", "all_site_policy": true, "description": "string", "order": 1 } ], "count": 1 } }, "MoveFirewallPolicyRuleInput": { "title": "MoveFirewallPolicyRuleInput", "type": "object", "properties": { "position": { "type": "integer", "description": "Position to move the rule to within the rule group.", "format": "int64" } }, "description": "Input parameters for moving a firewall policy rule to a new position", "example": { "position": 1 } }, "MoveFirewallPolicyRuleResponse": { "title": "MoveFirewallPolicyRuleResponse", "type": "object", "properties": { "position": { "type": "integer", "description": "New position of the moved rule", "format": "int64" } }, "description": "Response containing the new position after moving a firewall policy rule", "example": { "position": 1 } }, "ObjectInfoContentApplication": { "title": "ObjectInfoContentApplication", "required": [ "object_type", "object_uuid" ], "type": "object", "properties": { "object_type": { "$ref": "#/components/schemas/ObjectInfoContentApplicationObjectTypeApplicationEnum" }, "object_name": { "type": "string", "description": "Object Name." }, "object_uuid": { "type": "string", "description": "Object UUID." } }, "example": { "object_type": "APPLICATION", "object_name": "string", "object_uuid": "string" } }, "ObjectReference1": { "title": "ObjectReference1", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } }, "description": "Reference to a shared object identified by UUID. Name is populated by the server.", "example": { "uuid": "string", "name": "string" } }, "apiOutputFormat1": { "title": "apiOutputFormat1", "enum": [ "CLI", "XML" ], "type": "string", "description": "Output format for configuration.\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "example": "CLI" }, "apiPolicyDeploymentState": { "title": "apiPolicyDeploymentState", "enum": [ "POLICY_STATE_UNSPECIFIED", "POLICY_STATE_DEPLOY_PENDING", "POLICY_STATE_DEPLOYED", "POLICY_STATE_PARTIALLY_DEPLOYED", "POLICY_STATE_REDEPLOY_REQUIRED", "POLICY_STATE_DEPLOY_SCHEDULED", "POLICY_STATE_DEPLOY_FAILED", "POLICY_STATE_DEPLOY_IN_PROGRESS", "POLICY_STATE_MARKED_FOR_DELETE" ], "type": "string", "description": "PolicyDeploymentState represents the overall deployment state of a firewall policy.\n\n - POLICY_STATE_UNSPECIFIED: Default/unknown state\n - POLICY_STATE_DEPLOY_PENDING: Policy not deployed to any device\n - POLICY_STATE_DEPLOYED: Policy successfully deployed to all devices\n - POLICY_STATE_PARTIALLY_DEPLOYED: Policy deployed to some but not all devices\n - POLICY_STATE_REDEPLOY_REQUIRED: Policy changes require redeployment\n - POLICY_STATE_DEPLOY_SCHEDULED: Deployment scheduled but not yet started\n - POLICY_STATE_DEPLOY_FAILED: Deployment failed on one or more devices\n - POLICY_STATE_DEPLOY_IN_PROGRESS: Deployment currently in progress\n - POLICY_STATE_MARKED_FOR_DELETE: Policy marked for deletion", "example": "POLICY_STATE_UNSPECIFIED" }, "PolicyEntry": { "title": "PolicyEntry", "required": [ "policy_id" ], "type": "object", "properties": { "policy_id": { "type": "string", "description": "UUID of the policy" }, "policy_type": { "$ref": "#/components/schemas/apiPolicyType" } }, "description": "PolicyEntry represents a policy reference in batch operations", "example": { "policy_id": "string", "policy_type": "FIREWALL" } }, "PolicyOperationEntry": { "title": "PolicyOperationEntry", "required": [ "policy_id" ], "type": "object", "properties": { "policy_id": { "type": "string", "description": "UUID of the policy" }, "policy_type": { "$ref": "#/components/schemas/apiPolicyType" }, "deploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to deploy the policy to" }, "undeploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to undeploy the policy from" } }, "description": "PolicyOperationEntry represents a single policy's apply operations within a batch", "example": { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } }, "apiPolicyType": { "title": "apiPolicyType", "enum": [ "FIREWALL", "NAT" ], "type": "string", "description": "Type of policy.\n\n - FIREWALL: Firewall policy (default)\n - NAT: NAT policy", "example": "FIREWALL" }, "PreviewMultiplePoliciesRequest": { "title": "PreviewMultiplePoliciesRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyOperationEntry" }, "description": "List of policies to preview with their respective operations" } }, "description": "Request to preview multiple policies in a batch", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ] } }, "PreviewPolicyInput": { "title": "PreviewPolicyInput", "type": "object", "properties": { "deploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to preview deployment for. Shows what the configuration would look like without actual deployment." }, "undeploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to preview undeployment for. Shows what would be removed without actual changes." } }, "description": "Input message for preview operations (body only — no path params)", "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } }, "PreviewPolicyResponse": { "title": "PreviewPolicyResponse", "type": "object", "properties": { "preview_id": { "type": "string", "description": "Unique preview ID for tracking", "readOnly": true } }, "description": "Response for preview operations (single or batch)", "example": { "preview_id": "string" } }, "RuleDestinations": { "title": "RuleDestinations", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Destination zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Destination address endpoints." }, "url_category_lists": { "type": "array", "items": { "$ref": "#/components/schemas/UrlCategoryListReference" }, "description": "Destination URL category list endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the destination addresses are excluded (negated).", "default": false } }, "description": "RuleDestinations groups all destination endpoint types for a firewall rule.", "example": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "url_category_lists": [ { "uuid": "string", "name": "string" } ], "address_excluded": true } }, "RuleSources": { "title": "RuleSources", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Source zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Source address endpoints." }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityReference" }, "description": "Source identity (user) endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the source addresses are excluded (negated).", "default": false } }, "description": "RuleSources groups all source endpoint types for a firewall rule.", "example": { "zones": [ { "uuid": "string", "name": "string", "managed_variable": true } ], "addresses": [ { "uuid": "string", "name": "string" } ], "identities": [ { "uuid": "string", "name": "string" } ], "address_excluded": true } }, "AdvancedSecurity": { "title": "AdvancedSecurity", "type": "object", "properties": { "content_security_profile": { "$ref": "#/components/schemas/AdvancedSecurityContentSecurityProfile" }, "ips_profile": { "$ref": "#/components/schemas/AdvancedSecurityIpsProfile" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/AdvancedSecuritySslProxyProfile" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/AdvancedSecurityFlowBasedAntivirusProfile" }, "aamw_profile": { "$ref": "#/components/schemas/AdvancedSecurityAamwProfile" }, "secintel_profile_group": { "$ref": "#/components/schemas/AdvancedSecuritySecintelProfileGroup" }, "swp_profile": { "$ref": "#/components/schemas/AdvancedSecuritySwpProfile" }, "icap_profile": { "$ref": "#/components/schemas/AdvancedSecurityIcapProfile" } }, "description": "Groups all security subscription profiles for a firewall rule.", "example": { "content_security_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ips_profile": { "inherited": true, "uuid": "string", "name": "string" }, "ssl_proxy_profile": { "inherited": true, "uuid": "string", "name": "string" }, "flow_based_antivirus_profile": { "inherited": true, "uuid": "string", "name": "string" }, "aamw_profile": { "inherited": true, "uuid": "string", "name": "string" }, "secintel_profile_group": { "inherited": true, "uuid": "string", "name": "string" }, "swp_profile": { "inherited": true, "uuid": "string", "name": "string" }, "icap_profile": { "inherited": true, "uuid": "string", "name": "string" } } }, "SelectiveDeployMultiplePoliciesRequest": { "title": "SelectiveDeployMultiplePoliciesRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyOperationEntry" }, "description": "List of policies with their respective operations" }, "unassign_on_undeploy": { "type": "boolean", "description": "If true, also remove policy-device assignments when undeploying from targets. Applies to all policies in the batch.", "default": false } }, "description": "Request to selective deploy operations across multiple policies", "example": { "policies": [ { "policy_id": "string", "policy_type": "FIREWALL", "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ] } ], "unassign_on_undeploy": true } }, "SelectiveDeployPolicyInput": { "title": "SelectiveDeployPolicyInput", "type": "object", "properties": { "deploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to deploy the policy to. For each device, undeploy_targets are processed first, then deploy_targets." }, "undeploy_targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target" }, "description": "Target entities to undeploy the policy from. Processed before deploy_targets for each device." }, "unassign_on_undeploy": { "type": "boolean", "description": "If true, also remove policy-device assignments when undeploying from targets.", "default": false } }, "description": "Input message for selective deploy operations (body only — no path params)", "example": { "deploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "undeploy_targets": [ { "target_id": "string", "target_type": "DEVICE" } ], "unassign_on_undeploy": true } }, "SelectiveDeployPolicyResponse": { "title": "SelectiveDeployPolicyResponse", "type": "object", "properties": { "selective_deploy_id": { "type": "string", "description": "Unique selective deploy operation ID for tracking", "readOnly": true } }, "description": "Response for selective deploy operations", "example": { "selective_deploy_id": "string" } }, "Target": { "title": "Target", "required": [ "target_id", "target_type" ], "type": "object", "properties": { "target_id": { "type": "string", "description": "Device or device group ID" }, "target_type": { "$ref": "#/components/schemas/apiTargetType" } }, "example": { "target_id": "string", "target_type": "DEVICE" } }, "TargetAssignmentStatus": { "title": "TargetAssignmentStatus", "type": "object", "properties": { "target_uuid": { "type": "string", "description": "Device UUID" }, "target_type": { "$ref": "#/components/schemas/apiTargetType" }, "status": { "type": "string", "description": "Added or removed" } }, "example": { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } }, "apiTargetType": { "title": "apiTargetType", "enum": [ "DEVICE", "DEVICE_GROUP" ], "type": "string", "description": "Target type for deployment operations.\n\n - DEVICE: Individual device (default)\n - DEVICE_GROUP: Group of devices (Not supported, future support)", "example": "DEVICE" }, "UrlCategoryListReference": { "title": "UrlCategoryListReference", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "URL category list object UUID." }, "name": { "type": "string", "description": "URL category list object name. Populated by the server on read responses.", "readOnly": true } }, "description": "UrlCategoryListReference identifies a URL category list endpoint (destination only).", "example": { "uuid": "string", "name": "string" } }, "ZoneReference": { "title": "ZoneReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "This is mandatory when variable zone is true." }, "name": { "type": "string", "description": "Human-readable zone name. When variable zone is used, this will be populated by the server on read responses. Other wise, this is mandatory." }, "managed_variable": { "type": "boolean", "description": "When true, this refers to a variable zone defined in the application which holds separate zone mapped for different devices. When false, this item refers directly to a zone name specified in the 'name' field and it should be present in the device.", "default": false } }, "description": "ZoneReference identifies a zone endpoint.", "example": { "uuid": "string", "name": "string", "managed_variable": true } }, "format": { "title": "format", "enum": [ "CLI", "XML" ], "type": "string", "example": "CLI" }, "AdvancedSecurityAamwProfile": { "title": "AdvancedSecurityAamwProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecurityContentSecurityProfile": { "title": "AdvancedSecurityContentSecurityProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecurityFlowBasedAntivirusProfile": { "title": "AdvancedSecurityFlowBasedAntivirusProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecurityIcapProfile": { "title": "AdvancedSecurityIcapProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecurityIpsProfile": { "title": "AdvancedSecurityIpsProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecuritySecintelProfileGroup": { "title": "AdvancedSecuritySecintelProfileGroup", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecuritySslProxyProfile": { "title": "AdvancedSecuritySslProxyProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "AdvancedSecuritySwpProfile": { "title": "AdvancedSecuritySwpProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "ApiV1PoliciesCleanupRequest": { "title": "ApiV1PoliciesCleanupRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyEntry" }, "description": "List of policies to cleanup" }, "cleanup_mode": { "$ref": "#/components/schemas/apiCleanupMode" } } }, "ApiV1PoliciesDeployRequest": { "title": "ApiV1PoliciesDeployRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyEntry" }, "description": "List of policies to deploy" } } }, "ApiV1PoliciesFirewallRequest": { "title": "ApiV1PoliciesFirewallRequest", "required": [ "name", "order" ], "type": "object", "properties": { "name": { "type": "string", "description": "Policy name" }, "all_site_policy": { "type": "boolean", "description": "Flag to indicate if the policy is auto-assigned to all devices. When set to true, the policy will be dynamically assigned to all existing and future devices. No need to explicitly assign the policy to each device. When set to false, the policy needs to be explicitly assigned to devices. This property can not be changed once created. Default value is false.", "default": false }, "description": { "type": "string", "description": "Policy description." }, "order": { "type": "integer", "description": "Order of policy. Order starts from 1 any order beyond the current list size will be placed at the end of the list. 0 and negative order value not allowed.", "format": "int64" } } }, "ApiV1PoliciesPreviewRequest": { "title": "ApiV1PoliciesPreviewRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyOperationEntry" }, "description": "List of policies to preview with their respective operations" } } }, "ApiV1PoliciesSelectiveDeployRequest": { "title": "ApiV1PoliciesSelectiveDeployRequest", "required": [ "policies" ], "type": "object", "properties": { "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyOperationEntry" }, "description": "List of policies with their respective operations" }, "unassign_on_undeploy": { "type": "boolean", "description": "If true, also remove policy-device assignments when undeploying from targets. Applies to all policies in the batch.", "default": false } } }, "FirewallPolicyRuleAdvancedSecurity": { "title": "FirewallPolicyRuleAdvancedSecurity", "type": "object", "properties": { "content_security_profile": { "$ref": "#/components/schemas/AdvancedSecurityContentSecurityProfile" }, "ips_profile": { "$ref": "#/components/schemas/AdvancedSecurityIpsProfile" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/AdvancedSecuritySslProxyProfile" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/AdvancedSecurityFlowBasedAntivirusProfile" }, "aamw_profile": { "$ref": "#/components/schemas/AdvancedSecurityAamwProfile" }, "secintel_profile_group": { "$ref": "#/components/schemas/AdvancedSecuritySecintelProfileGroup" }, "swp_profile": { "$ref": "#/components/schemas/AdvancedSecuritySwpProfile" }, "icap_profile": { "$ref": "#/components/schemas/AdvancedSecurityIcapProfile" } } }, "FirewallPolicyRuleDestinations": { "title": "FirewallPolicyRuleDestinations", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Destination zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Destination address endpoints." }, "url_category_lists": { "type": "array", "items": { "$ref": "#/components/schemas/UrlCategoryListReference" }, "description": "Destination URL category list endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the destination addresses are excluded (negated).", "default": false } } }, "FirewallPolicyRuleInputAdvancedSecurity": { "title": "FirewallPolicyRuleInputAdvancedSecurity", "type": "object", "properties": { "content_security_profile": { "$ref": "#/components/schemas/AdvancedSecurityContentSecurityProfile" }, "ips_profile": { "$ref": "#/components/schemas/AdvancedSecurityIpsProfile" }, "ssl_proxy_profile": { "$ref": "#/components/schemas/AdvancedSecuritySslProxyProfile" }, "flow_based_antivirus_profile": { "$ref": "#/components/schemas/AdvancedSecurityFlowBasedAntivirusProfile" }, "aamw_profile": { "$ref": "#/components/schemas/AdvancedSecurityAamwProfile" }, "secintel_profile_group": { "$ref": "#/components/schemas/AdvancedSecuritySecintelProfileGroup" }, "swp_profile": { "$ref": "#/components/schemas/AdvancedSecuritySwpProfile" }, "icap_profile": { "$ref": "#/components/schemas/AdvancedSecurityIcapProfile" } } }, "FirewallPolicyRuleInputDestinations": { "title": "FirewallPolicyRuleInputDestinations", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Destination zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Destination address endpoints." }, "url_category_lists": { "type": "array", "items": { "$ref": "#/components/schemas/UrlCategoryListReference" }, "description": "Destination URL category list endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the destination addresses are excluded (negated).", "default": false } } }, "FirewallPolicyRuleInputOptions": { "title": "FirewallPolicyRuleInputOptions", "type": "object", "properties": { "logging": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsLogging2" }, "scheduler": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsScheduler" }, "redirect_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsRedirectProfile" }, "policy_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsPolicyProfile" }, "counter": { "allOf": [ { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsCounter" }, { "example": { "enable": true } } ] } } }, "FirewallPolicyRuleInputSources": { "title": "FirewallPolicyRuleInputSources", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Source zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Source address endpoints." }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityReference" }, "description": "Source identity (user) endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the source addresses are excluded (negated).", "default": false } } }, "FirewallPolicyRuleOptions": { "title": "FirewallPolicyRuleOptions", "type": "object", "properties": { "logging": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsLogging2" }, "scheduler": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsScheduler" }, "redirect_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsRedirectProfile" }, "policy_profile": { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsPolicyProfile" }, "counter": { "allOf": [ { "$ref": "#/components/schemas/FirewallRulesPolicyRuleOptionsCounter" }, { "example": { "enable": true } } ] } } }, "FirewallPolicyRuleSources": { "title": "FirewallPolicyRuleSources", "required": [ "zones", "addresses" ], "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneReference" }, "description": "Source zone endpoints." }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/AddressReference" }, "description": "Source address endpoints." }, "identities": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityReference" }, "description": "Source identity (user) endpoints." }, "address_excluded": { "type": "boolean", "description": "When true, the source addresses are excluded (negated).", "default": false } } }, "FirewallRulesPolicyRuleOptionsLogging2": { "title": "FirewallRulesPolicyRuleOptionsLogging2", "type": "object", "properties": { "session_initiate_log": { "type": "boolean", "description": "Enable logging when a session is initiated", "default": false }, "session_close_log": { "type": "boolean", "description": "Enable logging when a session is closed", "default": false } } }, "FirewallRulesPolicyRuleOptionsPolicyProfile": { "title": "FirewallRulesPolicyRuleOptionsPolicyProfile", "type": "object", "properties": { "inherited": { "type": "boolean", "description": "When true, the profile is inherited from the policy profile. UUID must not be provided.", "default": false }, "uuid": { "type": "string", "description": "UUID of the referenced object. Required when inherited is false." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "FirewallRulesPolicyRuleOptionsRedirectProfile": { "title": "FirewallRulesPolicyRuleOptionsRedirectProfile", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "FirewallRulesPolicyRuleOptionsScheduler": { "title": "FirewallRulesPolicyRuleOptionsScheduler", "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the referenced object." }, "name": { "type": "string", "description": "Name of the referenced object. Read-only, populated by the server.", "readOnly": true } } }, "format1": { "title": "format1", "enum": [ "CLI", "XML" ], "type": "string", "description": "Output format for deployed_config. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "example": "CLI" }, "format3": { "title": "format3", "enum": [ "CLI", "XML" ], "type": "string", "description": "Output format for config_diff. Specify CLI (CLI set commands - default) or XML (XML configuration only).\n\n - CLI: CLI configuration commands (default)\n - XML: XML configuration format", "example": "CLI" }, "BulkDeployImageRequest": { "title": "BulkDeployImageRequest", "required": [ "device_image_definitions" ], "type": "object", "properties": { "device_image_definitions": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceImageDefinition" }, "description": "Array of image deployment definitions. Each entry contains an image UUID and its target devices." } }, "description": "Request containing multiple image-device deployment definitions.", "example": { "device_image_definitions": [ { "uuid": "string", "targets": [ { "type": "DEVICE", "uuid": "string" } ] } ] } }, "BulkDeployImageResponse": { "title": "BulkDeployImageResponse", "type": "object", "properties": { "deploy_image_id": { "type": "string", "description": "Unique identifier for the bulk deploy job. Use this to query job status." } }, "description": "Response containing deploy job ID for the bulk deployment operation", "example": { "deploy_image_id": "string" } }, "CaCertificate": { "title": "CaCertificate", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the CA certificate" }, "name": { "type": "string", "description": "Name of the CA certificate" }, "device_uuid": { "type": "string", "description": "UUID of the device that holds this certificate" }, "common_name": { "type": "string", "description": "Common name (CN) of the CA certificate subject" }, "distinguished_name": { "type": "string", "description": "Distinguished name (DN) of the CA certificate subject" }, "organization_name": { "type": "string", "description": "Organization name as specified in the CA certificate subject" }, "state_or_province_name": { "type": "string", "description": "State or province name as specified in the CA certificate subject" }, "locality_name": { "type": "string", "description": "Locality (city) name as specified in the CA certificate subject" }, "public_key_algorithm": { "type": "string", "description": "Public key algorithm used by the CA certificate (e.g. rsaEncryption, dsaEncryption)" }, "key_size": { "type": "string", "description": "Size of the public key in bits (e.g. 1024, 2048)" }, "serial_number": { "type": "string", "description": "Serial number of the CA certificate in hexadecimal format" }, "expiry_date": { "type": "string", "description": "Certificate expiry date and time (e.g. 2035-12-09 17:41 UTC)" }, "signature_algorithm": { "type": "string", "description": "Signature algorithm used to sign the CA certificate (e.g. sha256WithRSAEncryption)" }, "finger_print_content": { "type": "string", "description": "Fingerprint of the CA certificate in multiple hash formats (sha1, md5, sha256)" }, "issuer_common_name": { "type": "string", "description": "Common name (CN) of the CA certificate issuer" }, "issuer_organization_name": { "type": "string", "description": "Organization name of the CA certificate issuer" }, "issuer_state_or_province_name": { "type": "string", "description": "State or province name of the CA certificate issuer" }, "issuer_locality_name": { "type": "string", "description": "Locality (city) name of the CA certificate issuer" } }, "description": "CA certificate installed on a device", "example": { "uuid": "string", "name": "string", "device_uuid": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } }, "CertificateType": { "title": "CertificateType", "enum": [ "CA", "LOCAL" ], "type": "string", "description": "CertificateType represents the type of certificate.\n\n - CA: CA certificate\n - LOCAL: Local (pki-local-certificate) certificate", "example": "CA" }, "CreateDeviceImageDefinitionRequest": { "title": "CreateDeviceImageDefinitionRequest", "required": [ "image_file_uri", "sha1_hash", "supported_platforms", "description" ], "type": "object", "properties": { "image_file_uri": { "type": "string", "description": "URL of the image file on the remote server." }, "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification" }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms for this image (e.g., VSRX3, SRX1500)" }, "description": { "type": "string", "description": "Description of the software image" } }, "description": "Request to add a image from a remote server URL", "example": { "image_file_uri": "string", "sha1_hash": "string", "supported_platforms": [ "VSRX" ], "description": "string" } }, "CreateDeviceImageDefinitionResponse": { "title": "CreateDeviceImageDefinitionResponse", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the newly added image", "readOnly": true }, "name": { "type": "string", "description": "Name of the image file", "readOnly": true }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms for this image" }, "version": { "type": "string", "description": "Version of the image", "readOnly": true }, "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification", "readOnly": true }, "description": { "type": "string", "description": "Description of the image", "readOnly": true } }, "description": "Response containing the details of the newly created image", "example": { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "description": "string" } }, "DeleteCertificateInput": { "title": "DeleteCertificateInput", "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the certificate to delete" }, "type": { "$ref": "#/components/schemas/CertificateType" } }, "description": "Body payload for deleting a certificate from a device.", "example": { "name": "string", "type": "CA" } }, "DeleteCertificateResponse": { "title": "DeleteCertificateResponse", "type": "object", "properties": { "delete_certificate_id": { "type": "string", "description": "Unique identifier for the delete certificate job. Use this to query job status." } }, "description": "Response containing delete certificate job ID for tracking", "example": { "delete_certificate_id": "string" } }, "DeployDeviceDetail": { "title": "DeployDeviceDetail", "type": "object", "properties": { "device_uuid": { "type": "string", "description": "Unique identifier of the device" }, "device_name": { "type": "string", "description": "Hostname or name of the device" }, "image_uuid": { "type": "string", "description": "Unique identifier of the image being deployed" }, "image_name": { "type": "string", "description": "Name of the image being deployed" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Optional descriptive message about the device deploy status (e.g., error details)" } }, "description": "Deploy status information for a single device", "example": { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } }, "DeployImageInput": { "title": "DeployImageInput", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target1" }, "description": "Array of device targets for the deployment operation." } }, "description": "Body payload containing device targets for image deployment.", "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } }, "DeployImageResponse": { "title": "DeployImageResponse", "type": "object", "properties": { "deploy_image_id": { "type": "string", "description": "Unique identifier for the deploy job. Use this to query job status." } }, "description": "Response containing deploy job ID", "example": { "deploy_image_id": "string" } }, "CaCertificate1": { "title": "CaCertificate1", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the CA certificate" }, "name": { "type": "string", "description": "Name of the CA certificate" }, "common_name": { "type": "string", "description": "Common name (CN) of the CA certificate subject" }, "distinguished_name": { "type": "string", "description": "Distinguished name (DN) of the CA certificate subject" }, "organization_name": { "type": "string", "description": "Organization name as specified in the CA certificate subject" }, "state_or_province_name": { "type": "string", "description": "State or province name as specified in the CA certificate subject" }, "locality_name": { "type": "string", "description": "Locality (city) name as specified in the CA certificate subject" }, "public_key_algorithm": { "type": "string", "description": "Public key algorithm used by the CA certificate (e.g. rsaEncryption, dsaEncryption)" }, "key_size": { "type": "string", "description": "Size of the public key in bits (e.g. 1024, 2048)" }, "serial_number": { "type": "string", "description": "Serial number of the CA certificate in hexadecimal format" }, "expiry_date": { "type": "string", "description": "Certificate expiry date and time (e.g. 2035-12-09 17:41 UTC)" }, "signature_algorithm": { "type": "string", "description": "Signature algorithm used to sign the CA certificate (e.g. sha256WithRSAEncryption)" }, "finger_print_content": { "type": "string", "description": "Fingerprint of the CA certificate in multiple hash formats (sha1, md5, sha256)" }, "issuer_common_name": { "type": "string", "description": "Common name (CN) of the CA certificate issuer" }, "issuer_organization_name": { "type": "string", "description": "Organization name of the CA certificate issuer" }, "issuer_state_or_province_name": { "type": "string", "description": "State or province name of the CA certificate issuer" }, "issuer_locality_name": { "type": "string", "description": "Locality (city) name of the CA certificate issuer" } }, "description": "CA certificate installed on a device", "example": { "uuid": "string", "name": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } }, "DeviceImageDefinition": { "title": "DeviceImageDefinition", "required": [ "uuid", "targets" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier (UUID) of the device image definition to deploy" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target1" }, "description": "Array of device targets for this image deployment." } }, "description": "An image and its target devices for deployment", "example": { "uuid": "string", "targets": [ { "type": "DEVICE", "uuid": "string" } ] } }, "LocalCertificate": { "title": "LocalCertificate", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the local certificate" }, "name": { "type": "string", "description": "Name of the local certificate" }, "distinguished_name": { "type": "string", "description": "Distinguished name (DN) of the certificate subject" }, "organization_name": { "type": "string", "description": "Organization name as specified in the certificate subject" }, "public_key_algorithm": { "type": "string", "description": "Public key algorithm used by the certificate (e.g. rsaEncryption, dsaEncryption)" }, "serial_number": { "type": "string", "description": "Serial number of the certificate in hexadecimal format" }, "validity_not_before": { "type": "string", "description": "Certificate validity start date and time" }, "validity_not_after": { "type": "string", "description": "Certificate validity end date and time" }, "key_size": { "type": "string", "description": "Size of the public key in bits (e.g. 1024, 2048)" }, "signature_algorithm": { "type": "string", "description": "Signature algorithm used to sign the certificate (e.g. dsaWithSHA1, sha256WithRSAEncryption)" }, "finger_print_content": { "type": "string", "description": "Fingerprint of the certificate in multiple hash formats (sha1, md5, sha256)" }, "auto_re_enrollment_status": { "type": "string", "description": "Auto re-enrollment status of the certificate (e.g. Enabled, Disabled)" }, "auto_re_enrollment_trigger_time": { "type": "string", "description": "Trigger time for automatic re-enrollment of the certificate" }, "email": { "type": "string", "description": "Email address associated with the certificate subject" }, "subject_alternate_domain_name": { "type": "string", "description": "Subject alternate domain name listed in the certificate" }, "ipv4_address": { "type": "string", "description": "IPv4 address listed in the certificate subject alternate name" }, "ipv6_address": { "type": "string", "description": "IPv6 address listed in the certificate subject alternate name" } }, "description": "Local certificate installed on a device", "example": { "uuid": "string", "name": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } }, "GetDeleteCertificateStatusResponse": { "title": "GetDeleteCertificateStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the delete certificate status" } }, "description": "Response containing delete certificate job status and details", "example": { "status": "FAILURE", "message": "string" } }, "GetDeployImageStatusResponse": { "title": "GetDeployImageStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Optional message when deploy fails at job level (e.g., device resolution failure)" }, "deploy_image_status": { "type": "array", "items": { "$ref": "#/components/schemas/DeployDeviceDetail" }, "description": "Array of device-specific deploy results with status for each device" } }, "description": "Response containing deploy job status and device results", "example": { "status": "FAILURE", "message": "string", "deploy_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } }, "GetInstallCaCertificateStatusResponse": { "title": "GetInstallCaCertificateStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the CA certificate installation status" } }, "description": "Response containing CA certificate installation job status and details", "example": { "status": "FAILURE", "message": "string" } }, "GetInstallLicenseStatusResponse": { "title": "GetInstallLicenseStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the license installation status" } }, "description": "Response containing license installation job status and details", "example": { "status": "FAILURE", "message": "string" } }, "GetInstallLocalCertificateStatusResponse": { "title": "GetInstallLocalCertificateStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Descriptive message about the local certificate installation status" } }, "description": "Response containing local certificate installation job status and details", "example": { "status": "FAILURE", "message": "string" } }, "GetStageImageStatusResponse": { "title": "GetStageImageStatusResponse", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Optional message when staging fails at job level (e.g., device resolution failure)" }, "stage_image_status": { "type": "array", "items": { "$ref": "#/components/schemas/StageDeviceDetail" }, "description": "Array of device-specific stage results with status for each device" } }, "description": "Response containing stage job status and device results", "example": { "status": "FAILURE", "message": "string", "stage_image_status": [ { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } ] } }, "InstallCaCertificateInput": { "title": "InstallCaCertificateInput", "required": [ "ca_certificate", "ca_profile_id" ], "type": "object", "properties": { "ca_certificate": { "type": "string", "description": "CA certificate file to be installed on the device. For REST API: upload as multipart/form-data in 'ca_certificate' form field." }, "ca_profile_id": { "type": "string", "description": "Unique identifier of the CA profile to associate with the installed certificate." } }, "description": "For multipart/form-data uploads, use form field 'ca_certificate' for the CA certificate file", "example": { "ca_certificate": "string", "ca_profile_id": "string" } }, "InstallCaCertificateResponse": { "title": "InstallCaCertificateResponse", "type": "object", "properties": { "install_ca_certificate_id": { "type": "string", "description": "Unique identifier for the CA certificate installation job. Use this to query job status." } }, "description": "Response containing install CA certificate job ID for tracking", "example": { "install_ca_certificate_id": "string" } }, "InstallLicenseInput": { "title": "InstallLicenseInput", "type": "object", "properties": { "license_file": { "type": "string", "description": "Txt file containing License information for standalone device. For REST API: upload as multipart/form-data in 'license_file' form field." }, "secondary_license_file": { "type": "string", "description": "Txt file containing License information for secondary device in cluster. For REST API: upload as multipart/form-data in 'secondary_license_file' form field." } }, "description": "For multipart/form-data uploads, use form field 'license_file' for the license text file", "example": { "license_file": "string", "secondary_license_file": "string" } }, "InstallLicenseResponse": { "title": "InstallLicenseResponse", "type": "object", "properties": { "install_license_id": { "type": "string", "description": "Unique identifier for the license installation job. Use this to query job status." } }, "description": "Response containing install license job ID for tracking", "example": { "install_license_id": "string" } }, "InstallLocalCertificateInput": { "title": "InstallLocalCertificateInput", "required": [ "certificate_id", "local_certificate", "local_certificate_key_file" ], "type": "object", "properties": { "certificate_id": { "type": "string", "description": "Unique identifier of the certificate to associate with the installed local certificate." }, "local_certificate": { "type": "string", "description": "Local certificate file to be installed on the device. For REST API: upload as multipart/form-data in 'local_certificate' form field." }, "local_certificate_key_file": { "type": "string", "description": "Private key file corresponding to the local certificate. For REST API: upload as multipart/form-data in 'local_certificate_key_file' form field." }, "pass_phrase": { "type": "string", "description": "Pass phrase used to encrypt/decrypt the private key file." } }, "description": "For multipart/form-data uploads, use form field 'local_certificate' for the certificate file and 'local_certificate_key_file' for the key file", "example": { "certificate_id": "string", "local_certificate": "string", "local_certificate_key_file": "string", "pass_phrase": "string" } }, "InstallLocalCertificateResponse": { "title": "InstallLocalCertificateResponse", "type": "object", "properties": { "install_local_certificate_id": { "type": "string", "description": "Unique identifier for the local certificate installation job. Use this to query job status." } }, "description": "Response containing install local certificate job ID for tracking", "example": { "install_local_certificate_id": "string" } }, "ListCaCertificatesResponse": { "title": "ListCaCertificatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CaCertificate" }, "description": "List of CA certificates" }, "count": { "type": "integer", "description": "Total number of CA certificates", "format": "int32" } }, "description": "Response containing the list of CA certificates installed on devices", "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } }, "ListDeviceCaCertificatesResponse": { "title": "ListDeviceCaCertificatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CaCertificate1" }, "description": "List of CA certificates installed on the device" }, "count": { "type": "integer", "description": "Total number of CA certificates installed on the device", "format": "int32" } }, "description": "Response containing the list of CA certificates installed on the specified device", "example": { "items": [ { "uuid": "string", "name": "string", "common_name": "string", "distinguished_name": "string", "organization_name": "string", "state_or_province_name": "string", "locality_name": "string", "public_key_algorithm": "string", "key_size": "string", "serial_number": "string", "expiry_date": "string", "signature_algorithm": "string", "finger_print_content": "string", "issuer_common_name": "string", "issuer_organization_name": "string", "issuer_state_or_province_name": "string", "issuer_locality_name": "string" } ], "count": 1 } }, "ListDeviceImageDefinitionsResponse": { "title": "ListDeviceImageDefinitionsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwareImage" }, "description": "Items contains the complete information of the requested images." }, "count": { "type": "integer", "description": "Total number of images available", "format": "int32" } }, "description": "Response containing list of images and total count", "example": { "items": [ { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "image_size": "string", "description": "string" } ], "count": 1 } }, "ListDeviceLocalCertificatesResponse": { "title": "ListDeviceLocalCertificatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LocalCertificate" }, "description": "List of local certificates installed on the device" }, "count": { "type": "integer", "description": "Total number of local certificates installed on the device", "format": "int32" } }, "description": "Response containing the list of local certificates installed on the specified device", "example": { "items": [ { "uuid": "string", "name": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } }, "ListLocalCertificatesResponse": { "title": "ListLocalCertificatesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LocalCertificate1" }, "description": "List of local certificates" }, "count": { "type": "integer", "description": "Total number of local certificates", "format": "int32" } }, "description": "Response containing the list of local certificates installed on devices", "example": { "items": [ { "uuid": "string", "name": "string", "device_uuid": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } ], "count": 1 } }, "LocalCertificate1": { "title": "LocalCertificate1", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the local certificate" }, "name": { "type": "string", "description": "Name of the local certificate" }, "device_uuid": { "type": "string", "description": "UUID of the device that holds this certificate" }, "distinguished_name": { "type": "string", "description": "Distinguished name (DN) of the certificate subject" }, "organization_name": { "type": "string", "description": "Organization name as specified in the certificate subject" }, "public_key_algorithm": { "type": "string", "description": "Public key algorithm used by the certificate (e.g. rsaEncryption, dsaEncryption)" }, "serial_number": { "type": "string", "description": "Serial number of the certificate in hexadecimal format" }, "validity_not_before": { "type": "string", "description": "Certificate validity start date and time" }, "validity_not_after": { "type": "string", "description": "Certificate validity end date and time" }, "key_size": { "type": "string", "description": "Size of the public key in bits (e.g. 1024, 2048)" }, "signature_algorithm": { "type": "string", "description": "Signature algorithm used to sign the certificate (e.g. dsaWithSHA1, sha256WithRSAEncryption)" }, "finger_print_content": { "type": "string", "description": "Fingerprint of the certificate in multiple hash formats (sha1, md5, sha256)" }, "auto_re_enrollment_status": { "type": "string", "description": "Auto re-enrollment status of the certificate (e.g. Enabled, Disabled)" }, "auto_re_enrollment_trigger_time": { "type": "string", "description": "Trigger time for automatic re-enrollment of the certificate" }, "email": { "type": "string", "description": "Email address associated with the certificate subject" }, "subject_alternate_domain_name": { "type": "string", "description": "Subject alternate domain name listed in the certificate" }, "ipv4_address": { "type": "string", "description": "IPv4 address listed in the certificate subject alternate name" }, "ipv6_address": { "type": "string", "description": "IPv6 address listed in the certificate subject alternate name" } }, "description": "Local certificate installed on a device", "example": { "uuid": "string", "name": "string", "device_uuid": "string", "distinguished_name": "string", "organization_name": "string", "public_key_algorithm": "string", "serial_number": "string", "validity_not_before": "string", "validity_not_after": "string", "key_size": "string", "signature_algorithm": "string", "finger_print_content": "string", "auto_re_enrollment_status": "string", "auto_re_enrollment_trigger_time": "string", "email": "string", "subject_alternate_domain_name": "string", "ipv4_address": "string", "ipv6_address": "string" } }, "SoftwareImage": { "title": "SoftwareImage", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the image" }, "name": { "type": "string", "description": "Name of the image file" }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms (e.g., VSRX3, SRX1500)" }, "version": { "type": "string", "description": "Version of the image (e.g., 23.4R2.13)" }, "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification" }, "image_size": { "type": "string", "description": "Human-readable size of the image file (e.g., 1.50 GB)" }, "description": { "type": "string", "description": "Optional description of the image" } }, "description": "Image details including version, platforms, and sha1_hash", "example": { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "image_size": "string", "description": "string" } }, "StageDeviceDetail": { "title": "StageDeviceDetail", "type": "object", "properties": { "device_uuid": { "type": "string", "description": "Unique identifier of the device" }, "device_name": { "type": "string", "description": "Hostname or name of the device" }, "image_uuid": { "type": "string", "description": "Unique identifier of the image being staged" }, "image_name": { "type": "string", "description": "Name of the image being staged" }, "status": { "$ref": "#/components/schemas/apiStatus" }, "message": { "type": "string", "description": "Optional descriptive message about the device stage status (e.g., error details)" } }, "description": "Stage status information for a single device", "example": { "device_uuid": "string", "device_name": "string", "image_uuid": "string", "image_name": "string", "status": "FAILURE", "message": "string" } }, "StageImageInput": { "title": "StageImageInput", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target1" }, "description": "Array of device targets for the staging operation." } }, "description": "Body payload containing device targets for image staging.", "example": { "targets": [ { "type": "DEVICE", "uuid": "string" } ] } }, "StageImageResponse": { "title": "StageImageResponse", "type": "object", "properties": { "stage_image_id": { "type": "string", "description": "Unique identifier for the stage job. Use this to query job status." } }, "description": "Response containing stage job ID", "example": { "stage_image_id": "string" } }, "SupportedPlatform": { "title": "SupportedPlatform", "enum": [ "VSRX", "VSRX3", "SRX300", "SRX320", "SRX340", "SRX345", "SRX380", "SRX400", "SRX440", "SRX550", "SRX1500", "SRX1600", "SRX2300", "SRX4100", "SRX4120", "SRX4200", "SRX4300", "SRX4600", "SRX4700", "SRX5400", "SRX5600", "SRX5800", "CSRX" ], "type": "string", "description": "SupportedPlatform defines the set of hardware/virtual platforms a software image can target.", "example": "VSRX" }, "Target1": { "title": "Target1", "required": [ "type", "uuid" ], "type": "object", "properties": { "type": { "enum": [ "DEVICE" ], "type": "string", "description": "TargetType enum defines the type of deployment target. DEVICE_GROUP will be supported later.\n\n - DEVICE: DEVICE - Target is a single device" }, "uuid": { "type": "string", "description": "Unique identifier of the device or device group" } }, "description": "Target device or device group for operations", "example": { "type": "DEVICE", "uuid": "string" } }, "TargetType": { "title": "TargetType", "enum": [ "DEVICE" ], "type": "string", "description": "TargetType enum defines the type of deployment target. DEVICE_GROUP will be supported later.\n\n - DEVICE: DEVICE - Target is a single device", "example": "DEVICE" }, "UploadImageRequest": { "title": "UploadImageRequest", "required": [ "sha1_hash", "supported_platforms", "description", "image_file" ], "type": "object", "properties": { "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification" }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms for this image (e.g., VSRX3, SRX1500)" }, "description": { "type": "string", "description": "Description of the software image" }, "image_file": { "type": "string", "description": "Image binary file (.tgz, .gz, .img, .iso). Upload the file as multipart/form-data in the 'image_file' form field (e.g., junos-vsrx3-x86-64-24.2R1.17.tgz')." } }, "description": "For multipart/form-data uploads, fields must be provided in the following order: sha1_hash, supported_platforms, description, image_file.", "example": { "sha1_hash": "string", "supported_platforms": [ "VSRX" ], "description": "string", "image_file": "string" } }, "UploadImageResponse": { "title": "UploadImageResponse", "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the uploaded image", "readOnly": true }, "name": { "type": "string", "description": "Name of the image file", "readOnly": true }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms for this image" }, "version": { "type": "string", "description": "Version of the image", "readOnly": true }, "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification", "readOnly": true }, "size": { "type": "string", "description": "Human-readable file size of the uploaded image (e.g., '1.5 GB', '256 MB')", "readOnly": true }, "description": { "type": "string", "description": "Description of the uploaded image", "readOnly": true } }, "description": "Response containing the details of the uploaded image", "example": { "uuid": "string", "name": "string", "supported_platforms": [ "VSRX" ], "version": "string", "sha1_hash": "string", "size": "string", "description": "string" } }, "ApiV1DeviceImageDefinitionsDeployImageRequest": { "title": "ApiV1DeviceImageDefinitionsDeployImageRequest", "required": [ "device_image_definitions" ], "type": "object", "properties": { "device_image_definitions": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceImageDefinition" }, "description": "Array of image deployment definitions. Each entry contains an image UUID and its target devices." } } }, "ApiV1DeviceImageDefinitionsRequest": { "title": "ApiV1DeviceImageDefinitionsRequest", "required": [ "image_file_uri", "sha1_hash", "supported_platforms", "description" ], "type": "object", "properties": { "image_file_uri": { "type": "string", "description": "URL of the image file on the remote server." }, "sha1_hash": { "type": "string", "description": "SHA1 hash of the image file for integrity verification" }, "supported_platforms": { "type": "array", "items": { "$ref": "#/components/schemas/SupportedPlatform" }, "description": "List of supported platforms for this image (e.g., VSRX3, SRX1500)" }, "description": { "type": "string", "description": "Description of the software image" } } }, "ApiV1DeviceImageDefinitionsStageImageRequest": { "title": "ApiV1DeviceImageDefinitionsStageImageRequest", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target1" }, "description": "Array of device targets for the staging operation." } } }, "ApiV1DevicesDeleteCertificateRequest": { "title": "ApiV1DevicesDeleteCertificateRequest", "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the certificate to delete" }, "type": { "$ref": "#/components/schemas/CertificateType" } } }, "ApiV1DeviceImageDefinitionsDeployImageRequest1": { "title": "ApiV1DeviceImageDefinitionsDeployImageRequest1", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target1" }, "description": "Array of device targets for the deployment operation." } } }, "apiAddressType": { "title": "apiAddressType", "enum": [ "ADDRESS_TYPE_ANY", "ADDRESS_TYPE_IPADDRESS", "ADDRESS_TYPE_WILDCARD", "ADDRESS_TYPE_RANGE", "ADDRESS_TYPE_DNS", "ADDRESS_TYPE_FQDN", "ADDRESS_TYPE_NETWORK" ], "type": "string", "description": "Type of address used in NAT rules.\n\n - ADDRESS_TYPE_ANY: Any address\n - ADDRESS_TYPE_IPADDRESS: IP address\n - ADDRESS_TYPE_WILDCARD: Wildcard address\n - ADDRESS_TYPE_RANGE: Address range\n - ADDRESS_TYPE_DNS: DNS name\n - ADDRESS_TYPE_FQDN: Fully qualified domain name\n - ADDRESS_TYPE_NETWORK: Network address", "example": "ADDRESS_TYPE_ANY" }, "ArpEntry": { "title": "ArpEntry", "type": "object", "properties": { "address": { "$ref": "#/components/schemas/ArpEntryAddress" }, "range_ip": { "type": "string", "description": "IP address range for this ARP entry." }, "intf_value": { "type": "string", "description": "Interface value for this ARP entry (e.g., ge-0/0/1.1602)." } }, "description": "Represents a single ARP entry with complete address information", "example": { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } }, "ArpNdpAddressReference": { "title": "ArpNdpAddressReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "type": "string", "description": "Type of the address object (IPADDRESS, NETWORK, DNS, etc.)." } }, "description": "Represents an address reference in ARP or Proxy NDP entries", "example": { "uuid": "string", "name": "string", "address_type": "string" } }, "BatchNatPoliciesMappingDevicesInput": { "title": "BatchNatPoliciesMappingDevicesInput", "type": "object", "properties": { "force_unassign": { "type": "boolean", "description": "Force unassign even if the policy is currently deployed to the device.", "default": false }, "assign": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentTarget" }, "description": "List of devices to assign to the policy." }, "unassign": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentTarget" }, "description": "List of devices to unassign from the policy." } }, "example": { "force_unassign": true, "assign": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "unassign": [ { "target_uuid": "string", "target_type": "DEVICE" } ] } }, "BatchNatPoliciesMappingDevicesResponse": { "title": "BatchNatPoliciesMappingDevicesResponse", "type": "object", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/TargetAssignmentStatus" }, "description": "List of assignment results." } }, "example": { "assignments": [ { "target_uuid": "string", "target_type": "DEVICE", "status": "string" } ] } }, "CreateNatPoolRequest": { "title": "CreateNatPoolRequest", "required": [ "name", "pool_address" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the NAT pool." }, "description": { "type": "string", "description": "Optional description." }, "pool_type": { "$ref": "#/components/schemas/apiNatPoolType" }, "pool_address": { "$ref": "#/components/schemas/CreateNatPoolRequestPoolAddressRef" }, "overflow_pool_address": { "$ref": "#/components/schemas/CreateNatPoolRequestOverflowPoolAddressRef" }, "routing_instance_name": { "type": "string", "description": "Routing instance name." }, "host_address_base": { "type": "string", "description": "Host address base." }, "address_shared": { "type": "boolean", "description": "Whether the pool address is shared.", "default": false }, "over_flow_pool_type": { "$ref": "#/components/schemas/apiNatOverFlowPoolType" }, "port_overloading_factor": { "type": "integer", "description": "Port overloading factor.", "format": "int32" }, "port_range": { "type": "string", "description": "Port range, e.g. '1024-65535'." }, "address_pooling": { "$ref": "#/components/schemas/apiNatAddressPooling" }, "port_value": { "$ref": "#/components/schemas/apiNatPortValue" }, "pool_translation": { "$ref": "#/components/schemas/apiNatPoolTranslation" } }, "description": "Request body for creating a NAT pool.", "example": { "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } }, "GetArpEntriesResponse": { "title": "GetArpEntriesResponse", "type": "object", "properties": { "arp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ArpEntry" }, "description": "List of ARP entries." }, "total": { "type": "integer", "description": "Total number of ARP entries returned.", "format": "int32" } }, "description": "Response containing ARP entries for the specified NAT rule parameters", "example": { "arp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } }, "GetNatPolicyStateResponse": { "title": "GetNatPolicyStateResponse", "type": "object", "properties": { "policy_state": { "$ref": "#/components/schemas/apiPolicyDeploymentState" }, "all_device_policy": { "type": "boolean", "description": "Is the policy an all device policy - All devices are implicitly mapped.", "default": false }, "assigned_devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceStateDetail" }, "description": "List of mapped devices and their deployment states." } }, "description": "Deployment state of a NAT policy, including per-device deployment details", "example": { "policy_state": "POLICY_STATE_UNSPECIFIED", "all_device_policy": true, "assigned_devices": [ { "device_uuid": "string", "device_deploy_state": "DEVICE_STATE_UNSPECIFIED", "description": "string" } ] } }, "GetProxyNdpEntriesResponse": { "title": "GetProxyNdpEntriesResponse", "type": "object", "properties": { "proxy_ndp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyNdpEntry" }, "description": "List of Proxy NDP entries." }, "total": { "type": "integer", "description": "Total number of Proxy NDP entries returned.", "format": "int32" } }, "description": "Response containing Proxy NDP entries for the specified NAT rule parameters", "example": { "proxy_ndp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ], "total": 1 } }, "ListNatPoliciesMappingDevicesResponse": { "title": "ListNatPoliciesMappingDevicesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatPolicyMappingDeviceOutput" }, "description": "List of mapping devices." }, "count": { "type": "integer", "description": "The total count of mapping devices matching the query.", "format": "int64" } }, "description": "Response containing a list of NAT policy mapping devices", "example": { "items": [ { "target_uuid": "string", "target_type": "DEVICE" } ], "count": 1 } }, "ListNatPoliciesResponse": { "title": "ListNatPoliciesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatPolicy" }, "description": "Array of NAT policy objects matching the query criteria." }, "count": { "type": "string", "description": "Total count of NAT Policies matching the query, used for pagination." } }, "description": "Response containing list of NAT Policies", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } ], "count": "string" } }, "ListNatPolicyHierarchyResponse": { "title": "ListNatPolicyHierarchyResponse", "type": "object", "properties": { "count": { "type": "string", "description": "Total count of items matching the query (before pagination)." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleHierarchyInfo" }, "description": "Array of rules and/or rule groups in hierarchical order." } }, "description": "Response containing hierarchy of NAT policy rules and rule groups", "example": { "count": "string", "items": [ { "id": "string", "name": "string", "type": "string", "position": 1, "group_id": "string", "sequence_number": 1, "description": "string" } ] } }, "ListNatPoolsResponse": { "title": "ListNatPoolsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatPool" }, "description": "Array of NAT pool objects matching the query criteria." }, "count": { "type": "string", "description": "Total count of NAT pools matching the query, used for pagination." } }, "description": "Response containing a paginated list of NAT pools.", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } ], "count": "string" } }, "ListNATRuleGroupsResponse": { "title": "ListNATRuleGroupsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleGroup" }, "description": "List of NAT rule groups." }, "count": { "type": "string", "description": "Total count of groups." } }, "description": "Response containing list of NAT rule groups", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1 } ], "count": "string" } }, "ListNATRulesResponse": { "title": "ListNATRulesResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatRule" }, "description": "List of NAT rules." }, "count": { "type": "string", "description": "Total count of rules." } }, "description": "Response containing list of NAT rules", "example": { "items": [ { "id": "string", "name": "string", "description": "string", "position": 1, "sequence_number": 1, "disabled": true, "group_id": "string", "nat_type": "NAT_TYPE_STATIC", "sources": { "traffic_scope": { "type": "NAT_RULE_MATCH_ZONE", "items": [ {} ] }, "addresses": [ { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" } ], "ports": "string" }, "destinations": { "traffic_scope": { "type": "NAT_RULE_MATCH_ZONE", "items": [ {} ] }, "addresses": [ { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" } ], "ports": "string" }, "applications": { "type": "NAT_APP_MATCH_NONE", "services": [ { "uuid": "string", "name": "string", "is_group": true } ], "protocols": [ { "protocol": "PROTOCOL_HOPOPT" } ] }, "translations": { "translation_type": "NAT_TRANSLATION_NO_TRANSLATION", "nat_pool": { "id": "string", "name": "string" }, "egress_interfaces": [ "string" ], "translated_address": { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" }, "ipv6_prefix": { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" }, "routing_instance": "string", "proxy_arp": { "proxy_arp_enabled": true, "arp_entries": [ {} ] }, "proxy_ndp": { "proxy_ndp_enabled": true, "proxy_ndp_entries": [ {} ] } }, "persistent_nat_settings": { "persistent_nat_type": "PERSISTENT_NAT_NONE", "address_mapping": true, "inactivity_timeout": 1, "max_session_number": 1 }, "mapped_port": "string" } ], "count": "string" } }, "MoveNatRuleGroupsInput": { "title": "MoveNatRuleGroupsInput", "required": [ "rule_group_id", "position" ], "type": "object", "properties": { "rule_group_id": { "type": "string", "description": "The NAT rule group ID to be moved. Must be a valid rule group identifier." }, "position": { "type": "integer", "description": "Position to which the rule group has to be moved", "format": "int32" } }, "description": "Input for moving NAT rule groups to a different position", "example": { "rule_group_id": "string", "position": 1 } }, "MoveNatRulesInput": { "title": "MoveNatRulesInput", "required": [ "rule_ids", "target_rule_group_id", "position" ], "type": "object", "properties": { "rule_ids": { "type": "array", "items": { "type": "string" }, "description": "Specify the NAT rule IDs to be moved. The list must not be empty and can contain a maximum of 50 rules." }, "target_rule_group_id": { "type": "string", "description": "The ID of the rule group to which the rules will be moved. If not provided, the rule will be treated as a policy-level rule and moved accordingly" }, "position": { "type": "integer", "description": "Position to which the rule has to be moved.", "format": "int32" } }, "description": "Input to move NAT rules to a different position or rule group within a policy", "example": { "rule_ids": [ "string" ], "target_rule_group_id": "string", "position": 1 } }, "apiNatAddressPooling": { "title": "apiNatAddressPooling", "enum": [ "NONE", "PAIRED", "NON_PAIRED" ], "type": "string", "description": "NatAddressPooling controls address pooling behaviour for a NAT pool.\n\n - NONE: NONE is the default; no address pooling.\n - PAIRED: PAIRED pairs source addresses with pool addresses.\n - NON_PAIRED: NON_PAIRED does not pair source with pool addresses.", "example": "NONE" }, "apiNatApplicationMatchType": { "title": "apiNatApplicationMatchType", "enum": [ "NAT_APP_MATCH_NONE", "NAT_APP_MATCH_SERVICE", "NAT_APP_MATCH_PROTOCOLS" ], "type": "string", "description": "Application match type for NAT rules.\n\n - NAT_APP_MATCH_NONE: No application match — apply to all traffic.\n - NAT_APP_MATCH_SERVICE: Match by application service objects.\n - NAT_APP_MATCH_PROTOCOLS: Match by protocol and port.", "example": "NAT_APP_MATCH_NONE" }, "apiNatOverFlowPoolType": { "title": "apiNatOverFlowPoolType", "enum": [ "OFP_NONE", "INTERFACE", "POOL" ], "type": "string", "description": "NatOverFlowPoolType identifies the overflow pool type for a NAT pool.\n\n - OFP_NONE: OFP_NONE is the default; no overflow pool is used.\n - INTERFACE: INTERFACE indicates the interface address is used as the overflow pool.\n - POOL: POOL indicates a separate NAT pool is used as the overflow pool.", "example": "OFP_NONE" }, "NatPolicy": { "title": "NatPolicy", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the NAT policy. This field is read-only and auto-generated by the system.", "readOnly": true }, "name": { "type": "string", "description": "Name of the NAT policy. Must be unique within the system." }, "description": { "type": "string", "description": "Optional description providing details about the NAT policy purpose and configuration." }, "proxy_arp_managed": { "type": "boolean", "description": "Indicates whether proxy ARP is managed by this NAT policy.", "default": false }, "enable_auto_arp": { "type": "boolean", "description": "When enabled, automatic ARP entries will be configured for NAT addresses.", "default": false }, "order": { "type": "integer", "description": "Numeric order value that controls the order in which policies are evaluated during processing. Lower values are processed first. A value of zero is invalid; if omitted, the policy is appended to the end of the sequence", "format": "int32" } }, "description": "Represents a complete NAT policy object", "example": { "id": "string", "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } }, "NatPolicyInput": { "title": "NatPolicyInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the NAT policy. Must be unique within the system." }, "description": { "type": "string", "description": "Optional description providing details about the NAT policy purpose and configuration." }, "proxy_arp_managed": { "type": "boolean", "description": "Indicates whether proxy ARP is managed by this NAT policy.", "default": false }, "enable_auto_arp": { "type": "boolean", "description": "When enabled, automatic ARP entries will be configured for NAT addresses.", "default": false }, "order": { "type": "integer", "description": "Absolute order of this rule in the overall policy. This computed by server and applicable only for rules.", "format": "int32" } }, "description": "Input fields for creating or updating a NAT policy", "example": { "name": "string", "description": "string", "proxy_arp_managed": true, "enable_auto_arp": true, "order": 1 } }, "NatPolicyMappingDeviceOutput": { "title": "NatPolicyMappingDeviceOutput", "type": "object", "properties": { "target_uuid": { "type": "string", "description": "Target UUID : Device UUID." }, "target_type": { "$ref": "#/components/schemas/apiTargetType" } }, "description": "Output structure for NAT policy device assignment operations", "example": { "target_uuid": "string", "target_type": "DEVICE" } }, "NatPool": { "title": "NatPool", "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the NAT pool. This field is read-only and auto-generated by the system.", "readOnly": true }, "name": { "type": "string", "description": "Name of the NAT pool. Must be unique within the domain." }, "description": { "type": "string", "description": "Optional description of the NAT pool." }, "pool_type": { "$ref": "#/components/schemas/apiNatPoolType" }, "pool_address": { "$ref": "#/components/schemas/NatPoolPoolAddressRef" }, "overflow_pool_address": { "$ref": "#/components/schemas/NatPoolOverflowPoolAddressRef" }, "routing_instance_name": { "type": "string", "description": "Name of the routing instance associated with this NAT pool." }, "host_address_base": { "type": "string", "description": "Host address base used for host-based NAT pools." }, "address_shared": { "type": "boolean", "description": "Indicates whether the pool address is shared across multiple policies.", "default": false }, "over_flow_pool_type": { "$ref": "#/components/schemas/apiNatOverFlowPoolType" }, "port_overloading_factor": { "type": "integer", "description": "Port overloading factor for PAT/NAPT operation.", "format": "int32" }, "port_range": { "type": "string", "description": "Port range for the NAT pool, e.g., '1024-65535'." }, "address_pooling": { "$ref": "#/components/schemas/apiNatAddressPooling" }, "port_value": { "$ref": "#/components/schemas/apiNatPortValue" }, "pool_translation": { "$ref": "#/components/schemas/apiNatPoolTranslation" } }, "description": "Represents a complete NAT pool object.", "example": { "id": "string", "name": "string", "description": "string", "pool_type": "SOURCE", "pool_address": { "id": "string", "name": "string" }, "overflow_pool_address": { "id": "string", "name": "string" }, "routing_instance_name": "string", "host_address_base": "string", "address_shared": true, "over_flow_pool_type": "OFP_NONE", "port_overloading_factor": 1, "port_range": "string", "address_pooling": "NONE", "port_value": "ANY", "pool_translation": "PORT_RANGE" } }, "NatPoolAddressRef": { "title": "NatPoolAddressRef", "type": "object", "properties": { "id": { "type": "string", "description": "UUID or numeric identifier of the address object." }, "name": { "type": "string", "description": "Name of the address object." } }, "description": "Reference to an address object (pool-address or overflow-pool-address).", "example": { "id": "string", "name": "string" } }, "apiNatPoolTranslation": { "title": "apiNatPoolTranslation", "enum": [ "PORT_RANGE", "PORT_OVERLOADING", "NO_TRANSLATION" ], "type": "string", "description": "NatPoolTranslation identifies the port translation mode for a NAT pool.\n\nused directly. This value is automatically stripped from generated API documentation.\n - PORT_RANGE: PORT_RANGE uses a configured port range for translation.\n - PORT_OVERLOADING: PORT_OVERLOADING uses port overloading (PAT/NAPT) for translation.\n - NO_TRANSLATION: NO_TRANSLATION disables port translation for this pool.", "example": "PORT_RANGE" }, "apiNatPoolType": { "title": "apiNatPoolType", "enum": [ "SOURCE", "DESTINATION" ], "type": "string", "description": "NatPoolType identifies whether a NAT pool is used for source or destination NAT.\n\nused directly; SOURCE is the effective default for NAT pools.\nThis value is automatically stripped from generated API documentation.\n - SOURCE: SOURCE indicates the pool is used for source NAT.\n - DESTINATION: DESTINATION indicates the pool is used for destination NAT.", "example": "SOURCE" }, "apiNatPortValue": { "title": "apiNatPortValue", "enum": [ "ANY", "RANGE", "PORT" ], "type": "string", "description": "NatPortValue identifies the port assignment mode for a NAT pool.\n\n - ANY: ANY is the default; any port may be used.\n - RANGE: RANGE restricts port assignment to the specified start/end range.\n - PORT: PORT restricts port assignment to a specific port.", "example": "ANY" }, "NatProxyArp": { "title": "NatProxyArp", "type": "object", "properties": { "proxy_arp_enabled": { "type": "boolean", "description": "Whether proxy ARP is enabled for the translated packet. When enabled, the device responds to ARP requests on behalf of the translated address.", "default": false }, "arp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ArpEntry" }, "description": "Proxy ARP entries associated with this NAT rule's translated packet. Populated when proxy ARP is enabled." } }, "description": "Proxy ARP configuration for NAT rule translated addresses", "example": { "proxy_arp_enabled": true, "arp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ] } }, "NatProxyNdp": { "title": "NatProxyNdp", "type": "object", "properties": { "proxy_ndp_enabled": { "type": "boolean", "description": "Whether proxy NDP (Neighbor Discovery Protocol) is enabled for the translated packet. Used for IPv6 NAT rules.", "default": false }, "proxy_ndp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyNdpEntry" }, "description": "Proxy NDP entries associated with this NAT rule's translated packet. Populated when proxy NDP is enabled." } }, "description": "Proxy NDP (Neighbor Discovery Protocol) configuration for IPv6 NAT rule translated addresses", "example": { "proxy_ndp_enabled": true, "proxy_ndp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ] } }, "NatRule": { "title": "NatRule", "required": [ "id", "name", "position", "nat_type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the NAT rule.", "readOnly": true }, "name": { "type": "string", "description": "Name of the NAT rule. Must be unique within the policy." }, "description": { "type": "string", "description": "Optional description providing details about the rule purpose." }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating or moving rules. This is ignored for update and returned only while listing the rule tree.", "format": "int32" }, "sequence_number": { "type": "integer", "description": "Absolute 1-based index of the rule across the entire policy. This is computed by server while processing the list and hence returned only in list responses; never set by the caller.", "format": "int32", "readOnly": true }, "disabled": { "type": "boolean", "description": "When true, the rule is disabled and will not be evaluated.", "default": false }, "group_id": { "type": "string", "description": "ID of the rule group this rule belongs to. Empty if the rule is not in a group.", "readOnly": true }, "nat_type": { "$ref": "#/components/schemas/apiNatType" }, "sources": { "$ref": "#/components/schemas/NatRuleSources" }, "destinations": { "$ref": "#/components/schemas/NatRuleDestinations" }, "applications": { "$ref": "#/components/schemas/NatRuleApplications2" }, "translations": { "$ref": "#/components/schemas/NatRuleTranslations2" }, "persistent_nat_settings": { "$ref": "#/components/schemas/NatRulePersistentNatSettings" }, "mapped_port": { "type": "string", "description": "Mapped port number or range for port translation." } }, "description": "Represents a single NAT rule within a policy" }, "NatRuleAddressReference": { "title": "NatRuleAddressReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "$ref": "#/components/schemas/apiAddressType" } }, "description": "Represents a reference to an address object", "example": { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" } }, "NatRuleApplications": { "title": "NatRuleApplications", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatApplicationMatchType" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleServiceReference" }, "description": "List of service object references. Must be specified when type is NAT_APP_MATCH_SERVICE." }, "protocols": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleProtocol" }, "description": "List of protocols. Must be specified when type is NAT_APP_MATCH_PROTOCOLS." } }, "description": "Application match configuration grouping services and protocols with a match type discriminator.", "example": { "type": "NAT_APP_MATCH_NONE", "services": [ { "uuid": "string", "name": "string", "is_group": true } ], "protocols": [ { "protocol": "PROTOCOL_HOPOPT" } ] } }, "NatRuleDestinationEndpoint": { "title": "NatRuleDestinationEndpoint", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleDestinationEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of destination address object references." }, "ports": { "type": "string", "description": "Destination port specification (e.g., '443' or '80,443')." } }, "description": "Destination traffic endpoint configuration grouping scope, addresses, and ports.", "example": { "traffic_scope": { "type": "NAT_RULE_MATCH_ZONE", "items": [ { "managed_variable": true, "uuid": "string", "name": "string" } ] }, "addresses": [ { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" } ], "ports": "string" } }, "NatRuleGroup": { "title": "NatRuleGroup", "required": [ "id", "name", "position" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the NAT rule group.", "readOnly": true }, "name": { "type": "string", "description": "Name of the rule group." }, "description": { "type": "string", "description": "Optional description of the rule group." }, "position": { "type": "integer", "description": "Position of the rule/group within its parent. This is set while creating or updating a rule.", "format": "int32" } }, "description": "Represents a group of NAT rules within a policy", "example": { "id": "string", "name": "string", "description": "string", "position": 1 } }, "NatRuleGroupInput": { "title": "NatRuleGroupInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the rule group." }, "description": { "type": "string", "description": "Optional description of the rule group." }, "position": { "type": "integer", "description": "Position of the rule/group within its parent. This is set while creating or updating a rule.", "format": "int32" } }, "description": "Input fields for creating a NAT rule group", "example": { "name": "string", "description": "string", "position": 1 } }, "NatRuleHierarchyInfo": { "title": "NatRuleHierarchyInfo", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the rule or rule group." }, "name": { "type": "string", "description": "Name of the rule or rule group." }, "type": { "type": "string", "description": "Type of the entry: 'RULE' for individual rules or 'GROUP' for rule groups." }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating or moving rules. This is ignored for update and returned only while listing the rule tree.", "format": "int32" }, "group_id": { "type": "string", "description": "Parent rule group UUID. Only populated for rules that belong to a rule group. Empty for top-level rules and for rule groups themselves." }, "sequence_number": { "type": "integer", "description": "Absolute 1-based index of the rule across the entire policy. This is computed by server while processing the list and hence returned only in list responses; never set by the caller.", "format": "int32" }, "description": { "type": "string", "description": "Rule description" } }, "description": "Minimal information about a NAT rule or rule group", "example": { "id": "string", "name": "string", "type": "string", "position": 1, "group_id": "string", "sequence_number": 1, "description": "string" } }, "NatRuleInput": { "title": "NatRuleInput", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the NAT rule. Must be unique within the policy." }, "description": { "type": "string", "description": "Optional description providing details about the rule purpose." }, "position": { "type": "integer", "description": "0-based index of the rule or group within its immediate parent (the policy, or a group). This is used only while creating or moving rules. This is ignored for update and returned only while listing the rule tree.", "format": "int32" }, "disabled": { "type": "boolean", "description": "When true, the rule is disabled and will not be evaluated.", "default": false }, "nat_type": { "$ref": "#/components/schemas/apiNatType" }, "sources": { "$ref": "#/components/schemas/NatRuleInputSources" }, "destinations": { "$ref": "#/components/schemas/NatRuleInputDestinations" }, "applications": { "$ref": "#/components/schemas/NatRuleInputApplications" }, "translations": { "$ref": "#/components/schemas/NatRuleInputTranslations" }, "persistent_nat_settings": { "$ref": "#/components/schemas/NatRuleInputPersistentNatSettings" }, "mapped_port": { "type": "string", "description": "Mapped port number or range for port translation." } }, "description": "Input fields for creating or updating a NAT rule" }, "apiNatRuleMatchType": { "title": "apiNatRuleMatchType", "enum": [ "NAT_RULE_MATCH_ZONE", "NAT_RULE_MATCH_INTERFACE", "NAT_RULE_MATCH_VIRTUAL_ROUTER" ], "type": "string", "description": "Type of traffic matching criteria for NAT rules.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching", "example": "NAT_RULE_MATCH_ZONE" }, "NatRulePoolReference": { "title": "NatRulePoolReference", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the NAT pool." }, "name": { "type": "string", "description": "Name of the NAT pool." } }, "description": "Represents a reference to a NAT pool", "example": { "id": "string", "name": "string" } }, "NatRuleProtocol": { "title": "NatRuleProtocol", "type": "object", "properties": { "protocol": { "$ref": "#/components/schemas/apiProtocolType" } }, "description": "Represents the protocol used in a NAT rule", "example": { "protocol": "PROTOCOL_HOPOPT" } }, "NatRuleServiceReference": { "title": "NatRuleServiceReference", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the service object." }, "name": { "type": "string", "description": "Name of the service object." }, "is_group": { "type": "boolean", "description": "Whether this is a service group.", "default": false } }, "description": "Represents a reference to a service object", "example": { "uuid": "string", "name": "string", "is_group": true } }, "NatRuleSourceEndpoint": { "title": "NatRuleSourceEndpoint", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleSourceEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of source address object references." }, "ports": { "type": "string", "description": "Source port specification (e.g., '1024-65535' or '80,443')." } }, "description": "Source traffic endpoint configuration grouping scope, addresses, and ports.", "example": { "traffic_scope": { "type": "NAT_RULE_MATCH_ZONE", "items": [ { "managed_variable": true, "uuid": "string", "name": "string" } ] }, "addresses": [ { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" } ], "ports": "string" } }, "NatRuleTranslations": { "title": "NatRuleTranslations", "type": "object", "properties": { "translation_type": { "$ref": "#/components/schemas/apiNatTranslationType" }, "nat_pool": { "$ref": "#/components/schemas/NatRuleTranslationsNatPool" }, "egress_interfaces": { "type": "array", "items": { "type": "string" }, "description": "List of egress interface names. Must be specified when translation_type is NAT_TRANSLATION_INTERFACE." }, "translated_address": { "$ref": "#/components/schemas/NatRuleTranslationsTranslatedAddress" }, "ipv6_prefix": { "$ref": "#/components/schemas/NatRuleTranslationsIpv6Prefix" }, "routing_instance": { "type": "string", "description": "Routing instance name. Used when translation_type is NAT_TRANSLATION_INET or NAT_TRANSLATION_NPTV6." }, "proxy_arp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyArp" }, "proxy_ndp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyNdp" } }, "description": "Translation configuration grouping all address conversion fields.", "example": { "translation_type": "NAT_TRANSLATION_NO_TRANSLATION", "nat_pool": { "id": "string", "name": "string" }, "egress_interfaces": [ "string" ], "translated_address": { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" }, "ipv6_prefix": { "uuid": "string", "name": "string", "address_type": "ADDRESS_TYPE_ANY" }, "routing_instance": "string", "proxy_arp": { "proxy_arp_enabled": true, "arp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ] }, "proxy_ndp": { "proxy_ndp_enabled": true, "proxy_ndp_entries": [ { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } ] } } }, "NatTrafficMatchItem": { "title": "NatTrafficMatchItem", "type": "object", "properties": { "managed_variable": { "type": "boolean", "description": "When true, this item refers to a variable object defined in the application which holds separate mappings for different devices. When false, this item refers directly to a zone, interface, or routing instance name specified in the 'name' field.", "default": false }, "uuid": { "type": "string", "description": "UUID of the managed variable. Required when managed_variable is true." }, "name": { "type": "string", "description": "Name of the zone, interface, or routing instance. Used when managed_variable is false." } }, "description": "A single traffic scope match item — either a fixed name or a managed variable reference.", "example": { "managed_variable": true, "uuid": "string", "name": "string" } }, "NatTrafficScope": { "title": "NatTrafficScope", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatRuleMatchType" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatTrafficMatchItem" }, "description": "List of match items (zones, interfaces, or routing instances)." } }, "description": "Traffic scope definition grouping match type with match items.", "example": { "type": "NAT_RULE_MATCH_ZONE", "items": [ { "managed_variable": true, "uuid": "string", "name": "string" } ] } }, "apiNatTranslationType": { "title": "apiNatTranslationType", "enum": [ "NAT_TRANSLATION_NO_TRANSLATION", "NAT_TRANSLATION_PREFIX", "NAT_TRANSLATION_POOL", "NAT_TRANSLATION_INTERFACE", "NAT_TRANSLATION_NPTV6", "NAT_TRANSLATION_INET" ], "type": "string", "description": "Translation method used for NAT address conversion.\n\n - NAT_TRANSLATION_NO_TRANSLATION: No translation\n - NAT_TRANSLATION_PREFIX: Prefix-based translation (Also called ADDRES translation)\n - NAT_TRANSLATION_POOL: Pool-based translation - Applicable only for SOURCE and DESTINATION NAT rules.\n - NAT_TRANSLATION_INTERFACE: Interface-based translation - Applicable only for SOURCE NAT rules.\n - NAT_TRANSLATION_NPTV6: NPTv6 (Network Prefix Translation for IPv6). Applicable only for STATIC NAT rules.\n - NAT_TRANSLATION_INET: INET translation (CORRESPONDING_IPV4). Applicable only for STATIC NAT rules.", "example": "NAT_TRANSLATION_NO_TRANSLATION" }, "apiNatType": { "title": "apiNatType", "enum": [ "NAT_TYPE_STATIC", "NAT_TYPE_SOURCE", "NAT_TYPE_DESTINATION" ], "type": "string", "description": "Type of NAT translation to apply.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT", "example": "NAT_TYPE_STATIC" }, "PersistentNatSettings": { "title": "PersistentNatSettings", "type": "object", "properties": { "persistent_nat_type": { "$ref": "#/components/schemas/apiPersistentNatType" }, "address_mapping": { "type": "boolean", "description": "Whether address mapping is enabled.", "default": false }, "inactivity_timeout": { "type": "integer", "description": "Inactivity timeout in seconds.", "format": "int32" }, "max_session_number": { "type": "integer", "description": "Maximum number of sessions (8-65536, default 30).", "format": "int32" } }, "description": "Represents persistent NAT configuration", "example": { "persistent_nat_type": "PERSISTENT_NAT_NONE", "address_mapping": true, "inactivity_timeout": 1, "max_session_number": 1 } }, "apiPersistentNatType": { "title": "apiPersistentNatType", "enum": [ "PERSISTENT_NAT_NONE", "PERSISTENT_NAT_TARGET_HOST", "PERSISTENT_NAT_TARGET_HOST_PORT", "PERSISTENT_NAT_ANY_REMOTE_HOST" ], "type": "string", "description": "Type of persistent NAT configuration.\n\n - PERSISTENT_NAT_NONE: No persistent NAT\n - PERSISTENT_NAT_TARGET_HOST: Target host persistent NAT\n - PERSISTENT_NAT_TARGET_HOST_PORT: Target host and port persistent NAT\n - PERSISTENT_NAT_ANY_REMOTE_HOST: Any remote host", "example": "PERSISTENT_NAT_NONE" }, "apiProtocolType": { "title": "apiProtocolType", "enum": [ "PROTOCOL_HOPOPT", "PROTOCOL_ICMP", "PROTOCOL_IGMP", "PROTOCOL_GGP", "PROTOCOL_IPV4", "PROTOCOL_ST", "PROTOCOL_TCP", "PROTOCOL_CBT", "PROTOCOL_EGP", "PROTOCOL_IGP", "PROTOCOL_BBN_RCC_MON", "PROTOCOL_NVP_II", "PROTOCOL_PUP", "PROTOCOL_ARGUS", "PROTOCOL_EMCON", "PROTOCOL_XNET", "PROTOCOL_CHAOS", "PROTOCOL_UDP", "PROTOCOL_MUX", "PROTOCOL_DCN_MEAS", "PROTOCOL_HMP", "PROTOCOL_PRM", "PROTOCOL_XNS_IDP", "PROTOCOL_TRUNK_1", "PROTOCOL_TRUNK_2", "PROTOCOL_LEAF_1", "PROTOCOL_LEAF_2", "PROTOCOL_RDP", "PROTOCOL_IRTP", "PROTOCOL_ISO_TP4", "PROTOCOL_NETBLT", "PROTOCOL_MFE_NSP", "PROTOCOL_MERIT_INP", "PROTOCOL_DCCP", "PROTOCOL_3PC", "PROTOCOL_IDPR", "PROTOCOL_XTP", "PROTOCOL_DDP", "PROTOCOL_IDPR_CMTP", "PROTOCOL_TP_PLUS_PLUS", "PROTOCOL_IL", "PROTOCOL_IPV6", "PROTOCOL_SDRP", "PROTOCOL_IPV6_ROUTE", "PROTOCOL_IPV6_FRAG", "PROTOCOL_IDRP", "PROTOCOL_RSVP", "PROTOCOL_GRE", "PROTOCOL_DSR", "PROTOCOL_BNA", "PROTOCOL_ESP", "PROTOCOL_AH", "PROTOCOL_I_NLSP", "PROTOCOL_SWIPE", "PROTOCOL_NARP", "PROTOCOL_MOBILE", "PROTOCOL_TLSP", "PROTOCOL_SKIP", "PROTOCOL_IPV6_ICMP", "PROTOCOL_IPV6_NONXT", "PROTOCOL_IPV6_OPTS", "PROTOCOL_ANY_HOST", "PROTOCOL_CFTP", "PROTOCOL_ANY_LOCAL", "PROTOCOL_SAT_EXPAK", "PROTOCOL_KRYPTOLAN", "PROTOCOL_RVD", "PROTOCOL_IPPC", "PROTOCOL_ANY_DFS", "PROTOCOL_SAT_MON", "PROTOCOL_VISA", "PROTOCOL_IPCV", "PROTOCOL_CPNX", "PROTOCOL_CPHB", "PROTOCOL_WSN", "PROTOCOL_PVP", "PROTOCOL_BR_SAT_MON", "PROTOCOL_SUN_ND", "PROTOCOL_WB_MON", "PROTOCOL_WB_EXPAK", "PROTOCOL_ISO_IP", "PROTOCOL_VMTP", "PROTOCOL_SECURE_VMTP", "PROTOCOL_VINES", "PROTOCOL_IPTM", "PROTOCOL_NSFNET_IGP", "PROTOCOL_DGP", "PROTOCOL_TCF", "PROTOCOL_EIGRP", "PROTOCOL_OSPFIGP", "PROTOCOL_SPRITE_RPC", "PROTOCOL_LARP", "PROTOCOL_MTP", "PROTOCOL_AX25", "PROTOCOL_IPIP", "PROTOCOL_MICP", "PROTOCOL_SCC_SP", "PROTOCOL_ETHERIP", "PROTOCOL_ENCAP", "PROTOCOL_ANY_ENCRYPT", "PROTOCOL_GMTP", "PROTOCOL_IFMP", "PROTOCOL_PNNI", "PROTOCOL_PIM", "PROTOCOL_ARIS", "PROTOCOL_SCPS", "PROTOCOL_QNX", "PROTOCOL_AN", "PROTOCOL_IPCOMP", "PROTOCOL_SNP", "PROTOCOL_COMPAQ_PEER", "PROTOCOL_IPX_IN_IP", "PROTOCOL_VRRP", "PROTOCOL_PGM", "PROTOCOL_ANY_0HOP", "PROTOCOL_L2TP", "PROTOCOL_DDX", "PROTOCOL_IATP", "PROTOCOL_STP", "PROTOCOL_SRP", "PROTOCOL_UTI", "PROTOCOL_SMP", "PROTOCOL_SM", "PROTOCOL_PTP", "PROTOCOL_ISIS_OVER_IPV4", "PROTOCOL_FIRE", "PROTOCOL_CRTP", "PROTOCOL_CRUDP", "PROTOCOL_SSCOPMCE", "PROTOCOL_IPLT", "PROTOCOL_SPS", "PROTOCOL_PIPE", "PROTOCOL_SCTP", "PROTOCOL_FC", "PROTOCOL_RSVP_E2E_IGNORE", "PROTOCOL_MOBILITY_HEADER", "PROTOCOL_UDPLITE", "PROTOCOL_MPLS_IN_IP", "PROTOCOL_MANET", "PROTOCOL_HIP", "PROTOCOL_SHIM6", "PROTOCOL_WESP", "PROTOCOL_ROHC", "PROTOCOL_143", "PROTOCOL_144", "PROTOCOL_145", "PROTOCOL_146", "PROTOCOL_147", "PROTOCOL_148", "PROTOCOL_149", "PROTOCOL_150", "PROTOCOL_151", "PROTOCOL_152", "PROTOCOL_153", "PROTOCOL_154", "PROTOCOL_155", "PROTOCOL_156", "PROTOCOL_157", "PROTOCOL_158", "PROTOCOL_159", "PROTOCOL_160", "PROTOCOL_161", "PROTOCOL_162", "PROTOCOL_163", "PROTOCOL_164", "PROTOCOL_165", "PROTOCOL_166", "PROTOCOL_167", "PROTOCOL_168", "PROTOCOL_169", "PROTOCOL_170", "PROTOCOL_171", "PROTOCOL_172", "PROTOCOL_173", "PROTOCOL_174", "PROTOCOL_175", "PROTOCOL_176", "PROTOCOL_177", "PROTOCOL_178", "PROTOCOL_179", "PROTOCOL_180", "PROTOCOL_181", "PROTOCOL_182", "PROTOCOL_183", "PROTOCOL_184", "PROTOCOL_185", "PROTOCOL_186", "PROTOCOL_187", "PROTOCOL_188", "PROTOCOL_189", "PROTOCOL_190", "PROTOCOL_191", "PROTOCOL_192", "PROTOCOL_193", "PROTOCOL_194", "PROTOCOL_195", "PROTOCOL_196", "PROTOCOL_197", "PROTOCOL_198", "PROTOCOL_199", "PROTOCOL_200", "PROTOCOL_201", "PROTOCOL_202", "PROTOCOL_203", "PROTOCOL_204", "PROTOCOL_205", "PROTOCOL_206", "PROTOCOL_207", "PROTOCOL_208", "PROTOCOL_209", "PROTOCOL_210", "PROTOCOL_211", "PROTOCOL_212", "PROTOCOL_213", "PROTOCOL_214", "PROTOCOL_215", "PROTOCOL_216", "PROTOCOL_217", "PROTOCOL_218", "PROTOCOL_219", "PROTOCOL_220", "PROTOCOL_221", "PROTOCOL_222", "PROTOCOL_223", "PROTOCOL_224", "PROTOCOL_225", "PROTOCOL_226", "PROTOCOL_227", "PROTOCOL_228", "PROTOCOL_229", "PROTOCOL_230", "PROTOCOL_231", "PROTOCOL_232", "PROTOCOL_233", "PROTOCOL_234", "PROTOCOL_235", "PROTOCOL_236", "PROTOCOL_237", "PROTOCOL_238", "PROTOCOL_239", "PROTOCOL_240", "PROTOCOL_241", "PROTOCOL_242", "PROTOCOL_243", "PROTOCOL_244", "PROTOCOL_245", "PROTOCOL_246", "PROTOCOL_247", "PROTOCOL_248", "PROTOCOL_249", "PROTOCOL_250", "PROTOCOL_251", "PROTOCOL_252", "PROTOCOL_253", "PROTOCOL_254", "PROTOCOL_RESERVED" ], "type": "string", "description": "IP protocol type for NAT rule matching.\n\n - PROTOCOL_HOPOPT: HOPOPT (0)\n - PROTOCOL_ICMP: ICMP (1)\n - PROTOCOL_IGMP: IGMP (2)\n - PROTOCOL_GGP: GGP (3)\n - PROTOCOL_IPV4: IPv4 (4)\n - PROTOCOL_ST: ST (5)\n - PROTOCOL_TCP: TCP (6)\n - PROTOCOL_CBT: CBT (7)\n - PROTOCOL_EGP: EGP (8)\n - PROTOCOL_IGP: IGP (9)\n - PROTOCOL_BBN_RCC_MON: BBN-RCC-MON (10)\n - PROTOCOL_NVP_II: NVP-II (11)\n - PROTOCOL_PUP: PUP (12)\n - PROTOCOL_ARGUS: ARGUS (13)\n - PROTOCOL_EMCON: EMCON (14)\n - PROTOCOL_XNET: XNET (15)\n - PROTOCOL_CHAOS: CHAOS (16)\n - PROTOCOL_UDP: UDP (17)\n - PROTOCOL_MUX: MUX (18)\n - PROTOCOL_DCN_MEAS: DCN-MEAS (19)\n - PROTOCOL_HMP: HMP (20)\n - PROTOCOL_PRM: PRM (21)\n - PROTOCOL_XNS_IDP: XNS-IDP (22)\n - PROTOCOL_TRUNK_1: TRUNK-1 (23)\n - PROTOCOL_TRUNK_2: TRUNK-2 (24)\n - PROTOCOL_LEAF_1: LEAF-1 (25)\n - PROTOCOL_LEAF_2: LEAF-2 (26)\n - PROTOCOL_RDP: RDP (27)\n - PROTOCOL_IRTP: IRTP (28)\n - PROTOCOL_ISO_TP4: ISO-TP4 (29)\n - PROTOCOL_NETBLT: NETBLT (30)\n - PROTOCOL_MFE_NSP: MFE-NSP (31)\n - PROTOCOL_MERIT_INP: MERIT-INP (32)\n - PROTOCOL_DCCP: DCCP (33)\n - PROTOCOL_3PC: 3PC (34)\n - PROTOCOL_IDPR: IDPR (35)\n - PROTOCOL_XTP: XTP (36)\n - PROTOCOL_DDP: DDP (37)\n - PROTOCOL_IDPR_CMTP: IDPR-CMTP (38)\n - PROTOCOL_TP_PLUS_PLUS: TP++ (39)\n - PROTOCOL_IL: IL (40)\n - PROTOCOL_IPV6: IPv6 (41)\n - PROTOCOL_SDRP: SDRP (42)\n - PROTOCOL_IPV6_ROUTE: IPv6-Route (43)\n - PROTOCOL_IPV6_FRAG: IPv6-Frag (44)\n - PROTOCOL_IDRP: IDRP (45)\n - PROTOCOL_RSVP: RSVP (46)\n - PROTOCOL_GRE: GRE (47)\n - PROTOCOL_DSR: DSR (48)\n - PROTOCOL_BNA: BNA (49)\n - PROTOCOL_ESP: ESP (50)\n - PROTOCOL_AH: AH (51)\n - PROTOCOL_I_NLSP: I-NLSP (52)\n - PROTOCOL_SWIPE: SWIPE (53)\n - PROTOCOL_NARP: NARP (54)\n - PROTOCOL_MOBILE: MOBILE (55)\n - PROTOCOL_TLSP: TLSP (56)\n - PROTOCOL_SKIP: SKIP (57)\n - PROTOCOL_IPV6_ICMP: IPv6-ICMP (58)\n - PROTOCOL_IPV6_NONXT: IPv6-NoNxt (59)\n - PROTOCOL_IPV6_OPTS: IPv6-Opts (60)\n - PROTOCOL_ANY_HOST: 61\n - PROTOCOL_CFTP: CFTP (62)\n - PROTOCOL_ANY_LOCAL: 63\n - PROTOCOL_SAT_EXPAK: SAT-EXPAK (64)\n - PROTOCOL_KRYPTOLAN: KRYPTOLAN (65)\n - PROTOCOL_RVD: RVD (66)\n - PROTOCOL_IPPC: IPPC (67)\n - PROTOCOL_ANY_DFS: 68\n - PROTOCOL_SAT_MON: SAT-MON (69)\n - PROTOCOL_VISA: VISA (70)\n - PROTOCOL_IPCV: IPCV (71)\n - PROTOCOL_CPNX: CPNX (72)\n - PROTOCOL_CPHB: CPHB (73)\n - PROTOCOL_WSN: WSN (74)\n - PROTOCOL_PVP: PVP (75)\n - PROTOCOL_BR_SAT_MON: BR-SAT-MON (76)\n - PROTOCOL_SUN_ND: SUN-ND (77)\n - PROTOCOL_WB_MON: WB-MON (78)\n - PROTOCOL_WB_EXPAK: WB-EXPAK (79)\n - PROTOCOL_ISO_IP: ISO-IP (80)\n - PROTOCOL_VMTP: VMTP (81)\n - PROTOCOL_SECURE_VMTP: SECURE-VMTP (82)\n - PROTOCOL_VINES: VINES (83)\n - PROTOCOL_IPTM: IPTM (84)\n - PROTOCOL_NSFNET_IGP: NSFNET-IGP (85)\n - PROTOCOL_DGP: DGP (86)\n - PROTOCOL_TCF: TCF (87)\n - PROTOCOL_EIGRP: EIGRP (88)\n - PROTOCOL_OSPFIGP: OSPFIGP (89)\n - PROTOCOL_SPRITE_RPC: Sprite-RPC (90)\n - PROTOCOL_LARP: LARP (91)\n - PROTOCOL_MTP: MTP (92)\n - PROTOCOL_AX25: AX.25 (93)\n - PROTOCOL_IPIP: IPIP (94)\n - PROTOCOL_MICP: MICP (95)\n - PROTOCOL_SCC_SP: SCC-SP (96)\n - PROTOCOL_ETHERIP: ETHERIP (97)\n - PROTOCOL_ENCAP: ENCAP (98)\n - PROTOCOL_ANY_ENCRYPT: 99\n - PROTOCOL_GMTP: GMTP (100)\n - PROTOCOL_IFMP: IFMP (101)\n - PROTOCOL_PNNI: PNNI (102)\n - PROTOCOL_PIM: PIM (103)\n - PROTOCOL_ARIS: ARIS (104)\n - PROTOCOL_SCPS: SCPS (105)\n - PROTOCOL_QNX: QNX (106)\n - PROTOCOL_AN: A/N (107)\n - PROTOCOL_IPCOMP: IPComp (108)\n - PROTOCOL_SNP: SNP (109)\n - PROTOCOL_COMPAQ_PEER: Compaq-Peer (110)\n - PROTOCOL_IPX_IN_IP: IPX-in-IP (111)\n - PROTOCOL_VRRP: VRRP (112)\n - PROTOCOL_PGM: PGM (113)\n - PROTOCOL_ANY_0HOP: 114\n - PROTOCOL_L2TP: L2TP (115)\n - PROTOCOL_DDX: DDX (116)\n - PROTOCOL_IATP: IATP (117)\n - PROTOCOL_STP: STP (118)\n - PROTOCOL_SRP: SRP (119)\n - PROTOCOL_UTI: UTI (120)\n - PROTOCOL_SMP: SMP (121)\n - PROTOCOL_SM: SM (122)\n - PROTOCOL_PTP: PTP (123)\n - PROTOCOL_ISIS_OVER_IPV4: ISIS over IPv4 (124)\n - PROTOCOL_FIRE: FIRE (125)\n - PROTOCOL_CRTP: CRTP (126)\n - PROTOCOL_CRUDP: CRUDP (127)\n - PROTOCOL_SSCOPMCE: SSCOPMCE (128)\n - PROTOCOL_IPLT: IPLT (129)\n - PROTOCOL_SPS: SPS (130)\n - PROTOCOL_PIPE: PIPE (131)\n - PROTOCOL_SCTP: SCTP (132)\n - PROTOCOL_FC: FC (133)\n - PROTOCOL_RSVP_E2E_IGNORE: RSVP-E2E-IGNORE (134)\n - PROTOCOL_MOBILITY_HEADER: Mobility Header (135)\n - PROTOCOL_UDPLITE: UDPLite (136)\n - PROTOCOL_MPLS_IN_IP: MPLS-in-IP (137)\n - PROTOCOL_MANET: manet (138)\n - PROTOCOL_HIP: HIP (139)\n - PROTOCOL_SHIM6: Shim6 (140)\n - PROTOCOL_WESP: WESP (141)\n - PROTOCOL_ROHC: ROHC (142)\n - PROTOCOL_143: 143\n - PROTOCOL_144: 144\n - PROTOCOL_145: 145\n - PROTOCOL_146: 146\n - PROTOCOL_147: 147\n - PROTOCOL_148: 148\n - PROTOCOL_149: 149\n - PROTOCOL_150: 150\n - PROTOCOL_151: 151\n - PROTOCOL_152: 152\n - PROTOCOL_153: 153\n - PROTOCOL_154: 154\n - PROTOCOL_155: 155\n - PROTOCOL_156: 156\n - PROTOCOL_157: 157\n - PROTOCOL_158: 158\n - PROTOCOL_159: 159\n - PROTOCOL_160: 160\n - PROTOCOL_161: 161\n - PROTOCOL_162: 162\n - PROTOCOL_163: 163\n - PROTOCOL_164: 164\n - PROTOCOL_165: 165\n - PROTOCOL_166: 166\n - PROTOCOL_167: 167\n - PROTOCOL_168: 168\n - PROTOCOL_169: 169\n - PROTOCOL_170: 170\n - PROTOCOL_171: 171\n - PROTOCOL_172: 172\n - PROTOCOL_173: 173\n - PROTOCOL_174: 174\n - PROTOCOL_175: 175\n - PROTOCOL_176: 176\n - PROTOCOL_177: 177\n - PROTOCOL_178: 178\n - PROTOCOL_179: 179\n - PROTOCOL_180: 180\n - PROTOCOL_181: 181\n - PROTOCOL_182: 182\n - PROTOCOL_183: 183\n - PROTOCOL_184: 184\n - PROTOCOL_185: 185\n - PROTOCOL_186: 186\n - PROTOCOL_187: 187\n - PROTOCOL_188: 188\n - PROTOCOL_189: 189\n - PROTOCOL_190: 190\n - PROTOCOL_191: 191\n - PROTOCOL_192: 192\n - PROTOCOL_193: 193\n - PROTOCOL_194: 194\n - PROTOCOL_195: 195\n - PROTOCOL_196: 196\n - PROTOCOL_197: 197\n - PROTOCOL_198: 198\n - PROTOCOL_199: 199\n - PROTOCOL_200: 200\n - PROTOCOL_201: 201\n - PROTOCOL_202: 202\n - PROTOCOL_203: 203\n - PROTOCOL_204: 204\n - PROTOCOL_205: 205\n - PROTOCOL_206: 206\n - PROTOCOL_207: 207\n - PROTOCOL_208: 208\n - PROTOCOL_209: 209\n - PROTOCOL_210: 210\n - PROTOCOL_211: 211\n - PROTOCOL_212: 212\n - PROTOCOL_213: 213\n - PROTOCOL_214: 214\n - PROTOCOL_215: 215\n - PROTOCOL_216: 216\n - PROTOCOL_217: 217\n - PROTOCOL_218: 218\n - PROTOCOL_219: 219\n - PROTOCOL_220: 220\n - PROTOCOL_221: 221\n - PROTOCOL_222: 222\n - PROTOCOL_223: 223\n - PROTOCOL_224: 224\n - PROTOCOL_225: 225\n - PROTOCOL_226: 226\n - PROTOCOL_227: 227\n - PROTOCOL_228: 228\n - PROTOCOL_229: 229\n - PROTOCOL_230: 230\n - PROTOCOL_231: 231\n - PROTOCOL_232: 232\n - PROTOCOL_233: 233\n - PROTOCOL_234: 234\n - PROTOCOL_235: 235\n - PROTOCOL_236: 236\n - PROTOCOL_237: 237\n - PROTOCOL_238: 238\n - PROTOCOL_239: 239\n - PROTOCOL_240: 240\n - PROTOCOL_241: 241\n - PROTOCOL_242: 242\n - PROTOCOL_243: 243\n - PROTOCOL_244: 244\n - PROTOCOL_245: 245\n - PROTOCOL_246: 246\n - PROTOCOL_247: 247\n - PROTOCOL_248: 248\n - PROTOCOL_249: 249\n - PROTOCOL_250: 250\n - PROTOCOL_251: 251\n - PROTOCOL_252: 252\n - PROTOCOL_253: 253\n - PROTOCOL_254: 254\n - PROTOCOL_RESERVED: Reserved (255)", "example": "PROTOCOL_HOPOPT" }, "ProxyNdpEntry": { "title": "ProxyNdpEntry", "type": "object", "properties": { "address": { "$ref": "#/components/schemas/ProxyNdpEntryAddress" }, "range_ip": { "type": "string", "description": "IPv6 address range for this NDP entry." }, "intf_value": { "type": "string", "description": "Interface value for this NDP entry (e.g., ge-0/0/1.1602)." } }, "description": "Represents a single Proxy NDP entry with complete address information", "example": { "address": { "uuid": "string", "name": "string", "address_type": "string" }, "range_ip": "string", "intf_value": "string" } }, "nat_type": { "title": "nat_type", "enum": [ "DUMMY_OPTION_UNSUPPORTED_NAT_TYPE", "NAT_TYPE_STATIC", "NAT_TYPE_SOURCE", "NAT_TYPE_DESTINATION" ], "type": "string", "example": "DUMMY_OPTION_UNSUPPORTED_NAT_TYPE" }, "traffic_match_type": { "title": "traffic_match_type", "enum": [ "DUMMY_OPTION_UNSUPPORTED_NAT_RULE_MATCH_TYPE", "NAT_RULE_MATCH_ZONE", "NAT_RULE_MATCH_INTERFACE", "NAT_RULE_MATCH_VIRTUAL_ROUTER" ], "type": "string", "example": "DUMMY_OPTION_UNSUPPORTED_NAT_RULE_MATCH_TYPE" }, "ApiV1NatPoolsRequest": { "title": "ApiV1NatPoolsRequest", "required": [ "name", "pool_address" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the NAT pool." }, "description": { "type": "string", "description": "Optional description." }, "pool_type": { "$ref": "#/components/schemas/apiNatPoolType" }, "pool_address": { "$ref": "#/components/schemas/CreateNatPoolRequestPoolAddressRef" }, "overflow_pool_address": { "$ref": "#/components/schemas/CreateNatPoolRequestOverflowPoolAddressRef" }, "routing_instance_name": { "type": "string", "description": "Routing instance name." }, "host_address_base": { "type": "string", "description": "Host address base." }, "address_shared": { "type": "boolean", "description": "Whether the pool address is shared.", "default": false }, "over_flow_pool_type": { "$ref": "#/components/schemas/apiNatOverFlowPoolType" }, "port_overloading_factor": { "type": "integer", "description": "Port overloading factor.", "format": "int32" }, "port_range": { "type": "string", "description": "Port range, e.g. '1024-65535'." }, "address_pooling": { "$ref": "#/components/schemas/apiNatAddressPooling" }, "port_value": { "$ref": "#/components/schemas/apiNatPortValue" }, "pool_translation": { "$ref": "#/components/schemas/apiNatPoolTranslation" } } }, "ArpEntryAddress": { "title": "ArpEntryAddress", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "type": "string", "description": "Type of the address object (IPADDRESS, NETWORK, DNS, etc.)." } } }, "CreateNatPoolRequestOverflowPoolAddressRef": { "title": "CreateNatPoolRequestOverflowPoolAddressRef", "type": "object", "properties": { "id": { "type": "string", "description": "UUID or numeric identifier of the address object." }, "name": { "type": "string", "description": "Name of the address object." } } }, "CreateNatPoolRequestPoolAddressRef": { "title": "CreateNatPoolRequestPoolAddressRef", "type": "object", "properties": { "id": { "type": "string", "description": "UUID or numeric identifier of the address object." }, "name": { "type": "string", "description": "Name of the address object." } } }, "nat_type1": { "title": "nat_type1", "enum": [ "DUMMY_OPTION_UNSUPPORTED_NAT_TYPE", "NAT_TYPE_STATIC", "NAT_TYPE_SOURCE", "NAT_TYPE_DESTINATION" ], "type": "string", "description": "The NAT type for the rule.\n\n - NAT_TYPE_STATIC: Static NAT\n - NAT_TYPE_SOURCE: Source NAT\n - NAT_TYPE_DESTINATION: Destination NAT", "example": "DUMMY_OPTION_UNSUPPORTED_NAT_TYPE" }, "NatPoolOverflowPoolAddressRef": { "title": "NatPoolOverflowPoolAddressRef", "type": "object", "properties": { "id": { "type": "string", "description": "UUID or numeric identifier of the address object." }, "name": { "type": "string", "description": "Name of the address object." } } }, "NatPoolPoolAddressRef": { "title": "NatPoolPoolAddressRef", "type": "object", "properties": { "id": { "type": "string", "description": "UUID or numeric identifier of the address object." }, "name": { "type": "string", "description": "Name of the address object." } } }, "NatRuleApplications2": { "title": "NatRuleApplications2", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatApplicationMatchType" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleServiceReference" }, "description": "List of service object references. Must be specified when type is NAT_APP_MATCH_SERVICE." }, "protocols": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleProtocol" }, "description": "List of protocols. Must be specified when type is NAT_APP_MATCH_PROTOCOLS." } } }, "NatRuleDestinationEndpointTrafficScope": { "title": "NatRuleDestinationEndpointTrafficScope", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatRuleMatchType" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatTrafficMatchItem" }, "description": "List of match items (zones, interfaces, or routing instances)." } } }, "NatRuleDestinations": { "title": "NatRuleDestinations", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleDestinationEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of destination address object references." }, "ports": { "type": "string", "description": "Destination port specification (e.g., '443' or '80,443')." } } }, "NatRuleInputApplications": { "title": "NatRuleInputApplications", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatApplicationMatchType" }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleServiceReference" }, "description": "List of service object references. Must be specified when type is NAT_APP_MATCH_SERVICE." }, "protocols": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleProtocol" }, "description": "List of protocols. Must be specified when type is NAT_APP_MATCH_PROTOCOLS." } } }, "NatRuleInputDestinations": { "title": "NatRuleInputDestinations", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleDestinationEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of destination address object references." }, "ports": { "type": "string", "description": "Destination port specification (e.g., '443' or '80,443')." } } }, "NatRuleInputPersistentNatSettings": { "title": "NatRuleInputPersistentNatSettings", "type": "object", "properties": { "persistent_nat_type": { "$ref": "#/components/schemas/apiPersistentNatType" }, "address_mapping": { "type": "boolean", "description": "Whether address mapping is enabled.", "default": false }, "inactivity_timeout": { "type": "integer", "description": "Inactivity timeout in seconds.", "format": "int32" }, "max_session_number": { "type": "integer", "description": "Maximum number of sessions (8-65536, default 30).", "format": "int32" } } }, "NatRuleInputSources": { "title": "NatRuleInputSources", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleSourceEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of source address object references." }, "ports": { "type": "string", "description": "Source port specification (e.g., '1024-65535' or '80,443')." } } }, "NatRuleInputTranslations": { "title": "NatRuleInputTranslations", "type": "object", "properties": { "translation_type": { "$ref": "#/components/schemas/apiNatTranslationType" }, "nat_pool": { "$ref": "#/components/schemas/NatRuleTranslationsNatPool" }, "egress_interfaces": { "type": "array", "items": { "type": "string" }, "description": "List of egress interface names. Must be specified when translation_type is NAT_TRANSLATION_INTERFACE." }, "translated_address": { "$ref": "#/components/schemas/NatRuleTranslationsTranslatedAddress" }, "ipv6_prefix": { "$ref": "#/components/schemas/NatRuleTranslationsIpv6Prefix" }, "routing_instance": { "type": "string", "description": "Routing instance name. Used when translation_type is NAT_TRANSLATION_INET or NAT_TRANSLATION_NPTV6." }, "proxy_arp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyArp" }, "proxy_ndp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyNdp" } } }, "NatRulePersistentNatSettings": { "title": "NatRulePersistentNatSettings", "type": "object", "properties": { "persistent_nat_type": { "$ref": "#/components/schemas/apiPersistentNatType" }, "address_mapping": { "type": "boolean", "description": "Whether address mapping is enabled.", "default": false }, "inactivity_timeout": { "type": "integer", "description": "Inactivity timeout in seconds.", "format": "int32" }, "max_session_number": { "type": "integer", "description": "Maximum number of sessions (8-65536, default 30).", "format": "int32" } } }, "NatRuleSourceEndpointTrafficScope": { "title": "NatRuleSourceEndpointTrafficScope", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/apiNatRuleMatchType" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/NatTrafficMatchItem" }, "description": "List of match items (zones, interfaces, or routing instances)." } } }, "NatRuleSources": { "title": "NatRuleSources", "type": "object", "properties": { "traffic_scope": { "$ref": "#/components/schemas/NatRuleSourceEndpointTrafficScope" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/NatRuleAddressReference" }, "description": "List of source address object references." }, "ports": { "type": "string", "description": "Source port specification (e.g., '1024-65535' or '80,443')." } } }, "NatRuleTranslations2": { "title": "NatRuleTranslations2", "type": "object", "properties": { "translation_type": { "$ref": "#/components/schemas/apiNatTranslationType" }, "nat_pool": { "$ref": "#/components/schemas/NatRuleTranslationsNatPool" }, "egress_interfaces": { "type": "array", "items": { "type": "string" }, "description": "List of egress interface names. Must be specified when translation_type is NAT_TRANSLATION_INTERFACE." }, "translated_address": { "$ref": "#/components/schemas/NatRuleTranslationsTranslatedAddress" }, "ipv6_prefix": { "$ref": "#/components/schemas/NatRuleTranslationsIpv6Prefix" }, "routing_instance": { "type": "string", "description": "Routing instance name. Used when translation_type is NAT_TRANSLATION_INET or NAT_TRANSLATION_NPTV6." }, "proxy_arp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyArp" }, "proxy_ndp": { "$ref": "#/components/schemas/NatRuleTranslationsProxyNdp" } } }, "NatRuleTranslationsIpv6Prefix": { "title": "NatRuleTranslationsIpv6Prefix", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "$ref": "#/components/schemas/apiAddressType" } } }, "NatRuleTranslationsNatPool": { "title": "NatRuleTranslationsNatPool", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the NAT pool." }, "name": { "type": "string", "description": "Name of the NAT pool." } } }, "NatRuleTranslationsProxyArp": { "title": "NatRuleTranslationsProxyArp", "type": "object", "properties": { "proxy_arp_enabled": { "type": "boolean", "description": "Whether proxy ARP is enabled for the translated packet. When enabled, the device responds to ARP requests on behalf of the translated address.", "default": false }, "arp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ArpEntry" }, "description": "Proxy ARP entries associated with this NAT rule's translated packet. Populated when proxy ARP is enabled." } } }, "NatRuleTranslationsProxyNdp": { "title": "NatRuleTranslationsProxyNdp", "type": "object", "properties": { "proxy_ndp_enabled": { "type": "boolean", "description": "Whether proxy NDP (Neighbor Discovery Protocol) is enabled for the translated packet. Used for IPv6 NAT rules.", "default": false }, "proxy_ndp_entries": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyNdpEntry" }, "description": "Proxy NDP entries associated with this NAT rule's translated packet. Populated when proxy NDP is enabled." } } }, "NatRuleTranslationsTranslatedAddress": { "title": "NatRuleTranslationsTranslatedAddress", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "$ref": "#/components/schemas/apiAddressType" } } }, "ProxyNdpEntryAddress": { "title": "ProxyNdpEntryAddress", "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the address object." }, "name": { "type": "string", "description": "Name of the address object." }, "address_type": { "type": "string", "description": "Type of the address object (IPADDRESS, NETWORK, DNS, etc.)." } } }, "traffic_match_type1": { "title": "traffic_match_type1", "enum": [ "DUMMY_OPTION_UNSUPPORTED_NAT_RULE_MATCH_TYPE", "NAT_RULE_MATCH_ZONE", "NAT_RULE_MATCH_INTERFACE", "NAT_RULE_MATCH_VIRTUAL_ROUTER" ], "type": "string", "description": "The traffic match type for source/destination matching.\n\n - NAT_RULE_MATCH_ZONE: Zone-based matching\n - NAT_RULE_MATCH_INTERFACE: Interface-based matching\n - NAT_RULE_MATCH_VIRTUAL_ROUTER: Virtual router matching", "example": "DUMMY_OPTION_UNSUPPORTED_NAT_RULE_MATCH_TYPE" }, "TargetResponseTargetTypeResponse": { "title": "TargetResponseTargetTypeResponse", "enum": [ "DEVICE" ], "type": "string", "example": "DEVICE" }, "AssociateSubscriptionInput": { "title": "AssociateSubscriptionInput", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target2" }, "description": "List of targets (devices) to associate the subscription with. Note: MNHA cluster UUIDs are not supported." } }, "description": "Body payload for associating a subscription to devices", "example": { "targets": [ { "id": "string", "type": "DEVICE" } ] } }, "ListSubscriptionAssociationsResponse": { "title": "ListSubscriptionAssociationsResponse", "required": [ "items", "count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TargetResponse" }, "description": "List of associated devices" }, "count": { "type": "integer", "description": "Total number of associated devices", "format": "int32" } }, "description": "List of devices associated with a subscription", "example": { "items": [ { "uuid": "string", "type": "DEVICE" } ], "count": 1 } }, "ListSubscriptionsResponse": { "title": "ListSubscriptionsResponse", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" }, "description": "List of subscriptions" }, "count": { "type": "integer", "description": "Total matching subscriptions", "format": "int32" } }, "example": { "items": [ { "uuid": "string", "product_SKU": "string", "ssrn": "string", "activation_code": "string", "start_date_int": "string", "end_date_int": "string", "duration": "string", "cust_contract_status": "string", "contract_status": "string", "type": "string", "subscription_name": "string", "entitlement": [ "string" ], "sku_type": "string", "sku_identifier": 1, "available_qty": "string", "activated_qty": "string" } ], "count": 1 } }, "Subscription": { "title": "Subscription", "type": "object", "properties": { "uuid": { "type": "string", "description": "Subscription UUID" }, "product_SKU": { "type": "string", "description": "Product SKU" }, "ssrn": { "type": "string", "description": "SSRN" }, "activation_code": { "type": "string", "description": "Activation code" }, "start_date_int": { "type": "string", "description": "Start date (epoch ms)" }, "end_date_int": { "type": "string", "description": "End date (epoch ms)" }, "duration": { "type": "string", "description": "Duration (human readable)" }, "cust_contract_status": { "type": "string", "description": "Customer contract status" }, "contract_status": { "type": "string", "description": "Contract status (cloud-only)" }, "type": { "type": "string", "description": "Subscription type (on-prem-only, e.g. trial)" }, "subscription_name": { "type": "string", "description": "Subscription name" }, "entitlement": { "type": "array", "items": { "type": "string" }, "description": "Entitlements" }, "sku_type": { "type": "string", "description": "SKU type" }, "sku_identifier": { "type": "integer", "description": "SKU identifier", "format": "int32" }, "available_qty": { "type": "string", "description": "Available quantity" }, "activated_qty": { "type": "string", "description": "Activated quantity" } }, "example": { "uuid": "string", "product_SKU": "string", "ssrn": "string", "activation_code": "string", "start_date_int": "string", "end_date_int": "string", "duration": "string", "cust_contract_status": "string", "contract_status": "string", "type": "string", "subscription_name": "string", "entitlement": [ "string" ], "sku_type": "string", "sku_identifier": 1, "available_qty": "string", "activated_qty": "string" } }, "Target2": { "title": "Target2", "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the device or device group" }, "type": { "enum": [ "DEVICE" ], "type": "string", "description": "TargetType identifies whether the target is an individual device or a device group.\n\n - DEVICE: Individual device." } }, "description": "A device or device group identified by UUID", "example": { "id": "string", "type": "DEVICE" } }, "TargetResponse": { "title": "TargetResponse", "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "UUID of the device or device group" }, "type": { "enum": [ "DEVICE" ], "type": "string" } }, "description": "A device or device group identified by UUID", "example": { "uuid": "string", "type": "DEVICE" } }, "TargetType1": { "title": "TargetType1", "enum": [ "DEVICE" ], "type": "string", "description": "TargetType identifies whether the target is an individual device or a device group.\n\n - DEVICE: Individual device.", "example": "DEVICE" }, "ApiV1SubscriptionsAssociationsCreateRequest": { "title": "ApiV1SubscriptionsAssociationsCreateRequest", "required": [ "targets" ], "type": "object", "properties": { "targets": { "type": "array", "items": { "$ref": "#/components/schemas/Target2" }, "description": "List of targets (devices) to associate the subscription with. Note: MNHA cluster UUIDs are not supported." } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "OauthKeyAuth": { "type": "apiKey", "name": "x-oauth2-token", "in": "header" } } }, "security": [ { "OauthKeyAuth": [] }, { "ApiKeyAuth": [] } ], "tags": [ { "name": "IAM", "description": "" }, { "name": "Site Management", "description": "" }, { "name": "Service Location Management", "description": "" }, { "name": "PAC Manager", "description": "" }, { "name": "Device Onboarding", "description": "" }, { "name": "License and Certificate Management", "description": "" }, { "name": "Device Groups", "description": "" }, { "name": "Device Operations", "description": "" }, { "name": "Device Resources", "description": "" }, { "name": "MNHA Clusters", "description": "" }, { "name": "Templates", "description": "" }, { "name": "RMA", "description": "" }, { "name": "AamwProfile", "description": "" }, { "name": "ContentFilteringProfile", "description": "" }, { "name": "ContentSecurityProfile", "description": "" }, { "name": "ContentSecuritySettings", "description": "" }, { "name": "EnhancedContentFilteringProfile", "description": "" }, { "name": "EnhancedContentFilteringProfileSet", "description": "" }, { "name": "DeviceGlobalSettings", "description": "" }, { "name": "GlobalProfile", "description": "" }, { "name": "GlobalSettings", "description": "" }, { "name": "IPSSignature", "description": "" }, { "name": "IpsProfile", "description": "" }, { "name": "IPSExemptRule", "description": "" }, { "name": "IPSRule", "description": "" }, { "name": "RuleOption", "description": "" }, { "name": "SecintelProfile", "description": "" }, { "name": "SSLProxyProfile", "description": "" }, { "name": "WebFilteringProfile", "description": "" }, { "name": "Address", "description": "" }, { "name": "AntiSpamProfile", "description": "" }, { "name": "AntiVirusProfile", "description": "" }, { "name": "Application", "description": "" }, { "name": "FlowBasedAntivirusProfile", "description": "" }, { "name": "IcapProfile", "description": "" }, { "name": "IcapServer", "description": "" }, { "name": "IdentityObject", "description": "" }, { "name": "IpsContext", "description": "" }, { "name": "IpsService", "description": "" }, { "name": "IpsVulnerability", "description": "" }, { "name": "ProxyServer", "description": "" }, { "name": "RedirectProfile", "description": "" }, { "name": "Scheduler", "description": "" }, { "name": "SecintelProfileGroup", "description": "" }, { "name": "Services", "description": "" }, { "name": "SSLInitiation", "description": "" }, { "name": "SWPProfile", "description": "" }, { "name": "URLCategoryList", "description": "" }, { "name": "URLPatterns", "description": "" }, { "name": "VariableZone", "description": "" }, { "name": "Policy Cleanup", "description": "" }, { "name": "Policy Deploy", "description": "" }, { "name": "Firewall Policies", "description": "" }, { "name": "Policy Assignment", "description": "" }, { "name": "Policy Preview", "description": "" }, { "name": "Policy Selective Deploy", "description": "" }, { "name": "Policy State", "description": "" }, { "name": "Device Image Definitions", "description": "" }, { "name": "NAT Pools", "description": "" }, { "name": "NAT Policies", "description": "" }, { "name": "Subscriptions", "description": "" } ] }