Apinizer and Data Management
Apinizer’s Data Retention Approach
Apinizer Manager Users
- User information required for platform management
- Authentication and authorization information
- User role and permission information
API Traffic Data
- Infrastructure is provided to store API traffic
- Masking, encryption, and deletion operations can be performed on data
- Data retention and deletion policies can be configured
Data Protection Features
Data Masking and Privacy
Apinizer provides comprehensive data masking and privacy features to protect sensitive data in API traffic:API Proxy Traffic Privacy Settings
API Proxy Traffic Privacy Settings
- Data Masking: Masking of sensitive fields (e.g., hiding credit card numbers except the last 4 digits)
- Hashing: One-way hashing for data protection (creating an irreversible value)
- Salt Usage: Salt value for hashing (adding random data to increase hash security)
- Field-based Operations: Element name and operation definitions (applying specific rules to certain JSON/XML fields)
- Header, query parameter, and body of message from client
- Header, query parameter, and body of message going to backend
- Header and body of message returning from backend
- Header and body of message returning to client
PII (Personally Identifiable Information) Protection
PII (Personally Identifiable Information) Protection
- Automatic Detection: Automatic detection of personal information (name, surname, email, phone number, etc.)
- PII Masking Policies: Personal information masking rules (automatic masking application to detected PII data)
- Data Minimization: Collection of only necessary data (principle of data collection limited to purpose)
- Sensitive Data Filtering: Filtering of sensitive data (filtering or blocking certain PII types from traffic)
Data Encryption
Data Encryption
- Encryption at Rest: Encryption in database (encryption of stored data)
- Encryption in Transit: Encryption during transmission (communication security with TLS/SSL)
- Field-level Encryption: Field-based encryption (encryption of certain sensitive fields)
- Key Management: Encryption key management (secure creation, storage, and management of keys)
Hashing and Salt
When hashing method is used in API Proxy Traffic Privacy Settings:Hashing Features
- One-way hashing (converting data to an irreversible digest)
- Irreversible (original data cannot be reached from hashed data)
- Security enhancement with salt (ensures same data produces different hash values)
- Secure data storage
Salt Usage
- Automatic salt generation by Apinizer (unique salt value generated for each hash operation)
- Secret storage (salt values are stored securely)
- Hashed data verification (used to verify the accuracy of hashed data)
- Security enhancement
Audit and Logging
Audit Records
Apinizer provides comprehensive audit records for compliance requirements:Token Requests
- Token requests from authentication module (authentication attempts and results)
- Token request data (request time, client information)
- Environment and date filtering (filtering records by specific environment and time range)
- User and API Proxy based filtering (viewing records belonging to specific user or API Proxy)
Login Records
- Management console login operations (all login attempts to management interface)
- User login records (which user logged in when)
- IP address tracking (recording IP addresses from which login was made)
- Login status (recording successful/unsuccessful login attempts)
Audit Records
- Changes made on the system (configuration, policy, user changes)
- Configuration changes (changes in API Proxy, environment, connection settings)
- User operations (administrative operations such as user creation, editing, deletion)
- Operation timestamps (recording when each operation was performed)
Test Console Audit Records
- Tests performed from test console (API calls made through test console)
- Test records (tested API, request and response details)
- Test results (successful/unsuccessful test results)
- Test user information (tracking which user performed which tests)
Application Logs
Application records include logs of worker, manager, and cache applications:Log Features
Log Features
- Start and End Date: Time range of log records
- Message Content: Detailed content of log message
- Logger Name: Name of logger that created the log record
- Log Type: Log level and type (ERROR, WARN, INFO, DEBUG, TRACE)
- Filtering Parameters: Advanced filtering options
Log Levels
Log Levels
- Error: Application errors and critical issues
- Warn: Potential issues or unexpected situations
- Info: General flow of application and important events
- Debug: Detailed information for development and debugging
- Trace: Lowest level, very detailed tracking information
- Off: Logging disabled (no log records are kept)
Log Storage
Log Storage
- Application Logs: 60 minutes retention period (by default)
- Automatic Log Cleanup: Automatic deletion of old logs after specified period
- Log Rotation: Rotation of log files by size or time
- Configurable Retention Policies: Customization of log retention periods
Log Management
Log Level Management
- Class/package based log level setting (changing log level for specific components)
- Manager, Gateway Engine, Cache log levels (managing log level of each component separately)
- Bulk update support (updating log levels of multiple components at once)
- Dynamic log level change (changing log level while system is running)
Log Filtering
- Date range filtering (viewing logs in a specific time period)
- Log type filtering (showing only logs of certain types like ERROR or WARN)
- Message content filtering (searching for keywords in log message)
- Logger name filtering (viewing logs belonging to a specific logger)
Data Storage and Retention
Data Retention Methods
Apinizer provides different retention and deletion methods for data retention:API Traffic Logs
API Traffic Logs
- Elasticsearch ILM: Automatic retention with Index Lifecycle Management (hot, warm, cold, delete phases)
- Configurable Retention Periods: Different retention periods for different log types (e.g., error logs can be stored longer)
- Automatic Deletion: Automatic deletion after specified period (with ILM policies)
- Manual Deletion: Manual deletion operations by user (deleting logs in specific date range)
- Index Rollover: Automatic rollover by index size or time
Application Logs
Application Logs
- Fixed Retention Period: 60 minutes retention period (default)
- Automatic Cleanup: Automatic cleanup after specified period
- Log Rotation: Rotation of log files by size or time
- Configurable Retention: Setting retention period according to needs
Audit Logs
Audit Logs
- Configurable Retention: Configurable retention for audit logs (according to compliance requirements)
- Automatic Deletion: Automatic deletion after specified period
- Manual Deletion: Manual deletion by user
- Long-term Retention: Long-term retention support for legal requirements
Data Storage Policies
Data Storage Policies
- Flexible Policies: Different storage policies for different data types (API traffic, audit, application logs)
- Time-based Deletion: Automatic deletion after specified date/period
- Manual Deletion: Manual deletion operations by user
- GDPR “Right to be Forgotten” Support: Data deletion mechanism (deletion of personal data upon request)
Security Controls
Access Control
Authentication
- OAuth2 / OIDC: Standard authentication protocols (industry standard authentication)
- JWT Tokens: JSON Web Token support (secure and verifiable token usage)
- Multi-factor Authentication: Multi-factor authentication support
- Session Management: Secure session management (secure management of user sessions)
Authorization
- Role-based Access Control (RBAC): Role-based access control (role-based access control)
- API Proxy Based Access Control: Control at API Proxy level (access permissions to specific API Proxies)
- Endpoint Based Access Control: Control at endpoint level (access permissions to specific endpoints within API Proxy)
- ACL (Access Control List) Management: Access control list management (detailed access control lists)
IP Control
- IP Whitelist/Blacklist: IP address based access control (allowing/blocking requests from specific IP addresses)
- X-Forwarded-For Support: Real IP detection behind proxy (detecting real client IP address behind proxy)
- Real IP Detection: Determining real client IP address (securely determining client’s real IP address)
Audit Logging
- All Access Records: Keeping access logs (API calls, administrative access)
- Change Records: Recording configuration changes (all configuration changes in the system)
- Operation Records: Audit record of all operations (important operations performed by users)
- Detailed Traceability: Tracking who did what, when
Data Security
Encryption
Encryption
- TLS/SSL Encryption (in Transit): Encryption during transmission (encryption of data during communication)
- Database Encryption (at Rest): Encryption in database (encryption of stored data)
- Field-level Encryption: Field-based encryption (special encryption of sensitive fields)
- Certificate Management: Certificate management (management of SSL/TLS certificates)
Data Integrity
Data Integrity
- Message Integrity: Message integrity check (verification that messages have not been altered)
- Digital Signatures: Digital signature support (guaranteeing data has not been altered with digital signatures)
- Hash Verification: Hash verification (verification of data’s hash value)
Security Monitoring
Security Monitoring
- Anomaly Detection: Detection of abnormal behavior (automatic detection of unexpected or suspicious behaviors)
- Security Events: Monitoring of security events (tracking security breaches or challenges in the system)
- Intrusion Detection: Attack detection (detection and alerting of system attacks)
- Security Monitoring: Security monitoring (continuous security monitoring and reporting)
Compliance Standards and Apinizer Support
GDPR Compliance
GDPR Requirements and Apinizer Support
GDPR (General Data Protection Regulation) is the European Union’s comprehensive regulation for the protection and processing of personal data. Apinizer provides the following features to meet GDPR requirements:Data Minimization (Article 5.1.c)
Data Minimization (Article 5.1.c)
- API Proxy Traffic Privacy Settings: Protection of sensitive data with masking or hashing
- Data Filtering: Removal of certain fields from logs
- Configurable Logging: Configuration to log only necessary data
- PII Detection: Automatic detection and protection of personal information
Right to be Forgotten (Article 17)
Right to be Forgotten (Article 17)
- Elasticsearch ILM: Automatic data deletion policies
- Manual Data Deletion: Manual deletion of data in specific date range
- Data Storage Policies: Configurable retention periods
- Data Cleanup Tasks: Automatic data cleanup tasks
Right to Data Portability (Article 20)
Right to Data Portability (Article 20)
- Data Export: Export of API traffic logs
- Standard Formats: Export in standard formats like JSON, CSV
- Filtering and Querying: Data export according to specific criteria
- Analytics Engine: Data viewing and export tools
Data Protection (Article 32)
Data Protection (Article 32)
- Data Encryption: Encryption at Rest and in Transit
- Data Masking: Protection of sensitive data with masking
- PII Protection: Automatic detection and protection of personal information
- Access Control: Access control with RBAC and ACL
Accountability (Article 5.2)
Accountability (Article 5.2)
- Comprehensive Audit Logging: Recording of all system changes
- Access Records: Recording of API calls and administrative access
- Change Tracking: Tracking of configuration changes
- Timestamped Records: Recording of each operation with timestamp
Data Breach Notification (Article 33-34)
Data Breach Notification (Article 33-34)
- Security Event Monitoring: Automatic detection of security events
- Alarms and Notifications: Automatic alarm and notification for security events
- Anomaly Detection: Detection of abnormal behaviors
- Log Analysis: Detection of security events through log analysis
KVKK Compliance
KVKK Requirements and Apinizer Support
KVKK (Personal Data Protection Law) is Turkey’s legal regulation for the processing and protection of personal data. Apinizer provides the following features to meet KVKK requirements:Explicit Consent (Article 5)
Explicit Consent (Article 5)
- Audit Records: Recording of all user operations
- Token Requests: Recording of authentication and authorization operations
- API Traffic Logs: Recording of API calls (for tracking consent status)
- Timestamped Records: Recording of consent given time
Obligation to Inform (Article 10)
Obligation to Inform (Article 10)
- API Documentation: Information about API usage
- Data Processing Records: Recording of data processing activities
- Log Viewing: Data subject viewing their own data
- Data Export: Data subject exporting their own data
Data Security (Article 12)
Data Security (Article 12)
- Technical Measures: Encryption, masking, access control
- Administrative Measures: RBAC, ACL, audit logging
- Security Tests: Security tests and evaluations
- Security Monitoring: Continuous security monitoring and reporting
Data Subject Rights (Article 11)
Data Subject Rights (Article 11)
- Right to Access: Data subject viewing their own data (Analytics Engine)
- Right to Correction: Correction of incorrect data (manual data correction)
- Right to Deletion: Data deletion mechanism (ILM and manual deletion)
- Right to Object: Right to object to data processing (stopping data processing)
CCPA Compliance
CCPA Requirements and Apinizer Support
CCPA (California Consumer Privacy Act) is California’s consumer privacy law. Apinizer provides the following features to meet CCPA requirements:Consumer Rights
Consumer Rights
- Right to Access: Data subject viewing their own data (Analytics Engine)
- Right to Deletion: Data deletion mechanism (ILM and manual deletion)
- Right to Opt-out of Sale: Right to object to data sale (stopping data processing)
- Data Export: Data subject exporting their own data
Transparency
Transparency
- Data Collection Descriptions: API documentation and terms of use
- Data Usage Information: Recording of data processing activities
- Third-party Sharing: Recording of data sharing
- Log Viewing: Data subject viewing their own data
Data Protection
Data Protection
- Secure Data Processing: Encryption, masking, access control
- Data Encryption: Encryption at Rest and in Transit
- Access Control: Access control with RBAC and ACL
- Security Monitoring: Continuous security monitoring and reporting
Audit
Audit
- Data Processing Records: Recording of all data processing activities
- Access Logs: Keeping access logs
- Change Tracking: Tracking of changes
- Timestamped Records: Recording of each operation with timestamp
ISO 27001 Preparation
ISO 27001 Controls and Apinizer Support
ISO 27001 is the information security management system standard. Apinizer provides the following features to meet ISO 27001 controls:Information Security Policies (A.5.1)
Information Security Policies (A.5.1)
- Security Policies: Security policies at API Proxy level
- Access Control Policies: Access control with RBAC and ACL
- Data Protection Policies: Data masking and encryption policies
- Documentation: Documentation of all policies
Access Control (A.9)
Access Control (A.9)
- Authentication: OAuth2, OIDC, JWT token support
- Authorization: RBAC, API Proxy based, Endpoint based access control
- ACL Management: Detailed access control lists
- IP Control: IP whitelist/blacklist support
Cryptography (A.10)
Cryptography (A.10)
- Encryption: Encryption at Rest and in Transit
- TLS/SSL: Encryption during transmission
- Field-level Encryption: Field-based encryption
- Key Management: Encryption key management
Information Security Incident Management (A.16)
Information Security Incident Management (A.16)
- Security Event Monitoring: Automatic detection of security events
- Alarms and Notifications: Automatic alarm and notification for security events
- Anomaly Detection: Detection of abnormal behaviors
- Incident Reporting: Reporting of security events
Operations Security (A.12)
Operations Security (A.12)
- Log Management: Comprehensive log management and storage
- Security Monitoring: Continuous security monitoring
- Backup: Data backup and recovery
- Change Management: Management of configuration changes
Compliance (A.18)
Compliance (A.18)
- Audit Records: Comprehensive audit records
- Data Protection: Data masking and encryption
- Data Retention: Configurable data storage policies
- Compliance Reporting: Creation of compliance reports
SOC 2 Preparation
SOC 2 Trust Principles and Apinizer Support
SOC 2 (Service Organization Control 2) is an audit standard based on security, availability, processing integrity, confidentiality, and privacy principles. Apinizer provides the following features to meet SOC 2 requirements:Security
Security
- Access Control: Access control with RBAC, ACL, IP control
- Authentication: OAuth2, OIDC, JWT token support
- Encryption: Encryption at Rest and in Transit
- Security Monitoring: Continuous security monitoring and alarms
Availability
Availability
- High Availability: Horizontal scaling and load balancing
- Failover: Automatic failover mechanism
- Monitoring: System performance monitoring
- Backup and Recovery: Data backup and recovery
Processing Integrity
Processing Integrity
- Data Accuracy: Message integrity check
- Operation Verification: Verification of operations
- Error Management: Error management mechanisms
- Audit Logging: Recording of all operations
Confidentiality
Confidentiality
- Data Encryption: Encryption at Rest and in Transit
- Data Masking: Masking of sensitive data
- Access Control: Access control with RBAC and ACL
- Security Monitoring: Detection of confidentiality breaches
Privacy
Privacy
- Personal Information Protection: PII protection and masking
- Data Storage Policies: Configurable data storage
- Data Deletion: Automatic and manual data deletion
- Privacy Monitoring: Detection of privacy breaches
Compliance Checklist
GDPR Checklist
Data Protection
Data Protection
- Data encryption active (TLS/SSL, Encryption at Rest)
- Data masking configured (API Proxy Traffic Privacy Settings)
- PII protection policies defined
- Data retention periods determined (Elasticsearch ILM)
Audit
Audit
- Audit logging active
- Access records being kept
- Change records being kept
- Log retention policies defined
Rights
Rights
- Data access mechanism available (Analytics Engine)
- Data deletion mechanism available (ILM, manual deletion)
- Data correction mechanism available
- Data portability support available (Export)
ISO 27001 Checklist
Security Controls
- Access control configured (RBAC, ACL)
- Encryption active (TLS/SSL, Encryption at Rest)
- Security monitoring configured (Anomaly detection, Alarms)
- Incident management procedures available
Documentation
- Security policies documented
- Procedures defined
- Risk assessment performed
Best Practices
Data Minimization
- Collect only necessary data
- Limit data retention periods
- Delete unused data
- Clarify data collection purpose
Security
- Use strong encryption (TLS 1.3, strong algorithms)
- Perform regular security updates
- Keep access control strict (RBAC, ACL)
- Perform security tests regularly
Audit
- Log all operations
- Regularly review logs
- Perform anomaly detection
- Store audit records
Training
- Train personnel
- Create security awareness
- Organize regular training
- Share compliance requirements

