Skip to content

Myra Online Help

Initial configurations

DE

Initializing search

Home
Myra App
Myra DataHub
API
Reference

Myra Online Help

Home
Myra App
Myra App
- Description
  Description
  - Myra: Security - easy and fast
- Getting Started
  Getting Started
  - Set up account
    Set up account
    
    Activating Your Account
    
    Enabling Two-Factor Authentication
  - Logging in and out
    Logging in and out
    
    Logging In Using Your Username and Password
    
    Logging In Using Single Sign-On (SSO)
    
    Log Out
  - Opening the Myra App
  - Open User Management
  - Myra App User Interface
  - Role Concept in the Myra App
  - Your consent to data processing by tracking tools
- Views
  Views
  - User management
    
    User management
    
    Profile
    
    Profile
    
    Details tab
    
    Assigned groups tab
    
    Active sessions tab
    
    API access tab
    
    API access tab
    
    API tokens tab
    
    API tokens tab
    
    Create new API token dialog
    
    API keys tab
    
    API keys tab
    
    Create new API key dialog
    
    Login history tab
    
    Notification settings tab
    
    User management
    
    User management
    
    User details for
    
    Add a user's account
    
    Edit the account of a user
    
    Edit the account of a user
    
    Changing the user name
    
    Lock or unlock a user's account
    
    Add a user to a group
    
    Removing a user from a group
    
    Edit user permissions
    
    Delete account
    
    Group Management
    
    Group Management
    
    Group List Area
    
    Group List Area
    
    Add group
    
    Edit the name of a group
    
    Changing the position of a group
    
    Delete group
    
    Details Area
    
    Accounts of a Group Area
    
    Accounts of a Group Area
    
    Add users to a group
    
    Changing the role of a user
    
    Removing users from a group
    
    Permissions Area
    
    Permissions Area
    
    Edit a group's permissions
    
    Permission views
    
    Permission views
    
    Global Permissions Option
    
    Global Permissions Option
    
    Domains Permission
    
    Tags Permission
    
    Networks Permission
    
    Local Permissions Area
    
    Local Permissions Area
    
    Domains tab
    
    Tag tab
    
    Network tab
    
    Admin Settings
    
    Admin Settings
    
    Account Security tab
    
    SSO Configuration tab
    
    Contacts & Communication tab
    
    Contacts & Communication tab
    
    Contact list tab
    
    Contact list tab
    
    Add contact
    
    Edit contact
    
    Delete contact
    
    Communication matrix tab
    
    Communication matrix tab
    
    Customize the communication matrix
  - Myra App views
    
    Myra App views
    
    Dashboard
    
    AI Assistant
    
    Notification Center
    
    Domains
    
    Domains
    
    Add New Domain dialog
    
    Subdomain settings
    
    Subdomain settings
    
    Settings
    
    Settings
    
    Connection tab
    
    Security tab
    
    Performance tab
    
    Logging tab
    
    Expert tab
    
    Upstream Error Reporting tab
    
    Custom tab
    
    Redirects
    
    Redirects
    
    Add new redirect / Edit redirect dialog
    
    Cache settings
    
    Cache settings
    
    Add Cache Rule / Edit Cache Rule dialog
    
    IP Allow/Blocklist
    
    IP Allow/Blocklist
    
    Add Entry / Edit Entry dialog
    
    WAF rules
    
    WAF rules
    
    New WAF Rule / Edit Rule
    
    Copy rule
    
    Description of conditions for WAF rules
    
    Description of actions for WAF rules
    
    Overview
    
    Maintenance Page
    
    Maintenance Page
    
    Create a New Maintenance Page / Edit a Maintenance Page
    
    Maintenance templates
    
    Clear Cache dialog
    
    DNS Records
    
    DNS Records
    
    Add new DNS record / Edit DNS record dialog
    
    Load Balancing
    
    Load Balancing
    
    Edit loadbalancing record dialog
    
    SSL/TLS Certificate Management
    
    SSL/TLS Certificate Management
    
    SSL/TLS Certificate Details
    
    Create an SSL/TLS certificate for dialog
    
    Configure SSL/TLS Certificate dialog
    
    Manage providers
    
    Manage providers
    
    Add provider / Edit provider dialog
    
    Custom Error Pages
    
    Custom Error Pages
    
    Create new custom error Page / Edit error page
    
    Waiting Room
    
    Waiting Room
    
    Create new waiting room / Edit waiting room
    
    Tags
    
    Tags
    
    WAF tab (tags)
    
    WAF tab (tags)
    
    View WAF rules
    
    Edit WAF rule for tag
    
    Cache tab (tags)
    
    Cache tab (tags)
    
    Edit cache rules view
    
    Settings tab (tags)
    
    Information tab (Tags)
    
    Information tab (Tags)
    
    Edit information tags
    
    Create tag / Properties and assignment / Copy tag
    
    Statistics
    
    Statistics
    
    Overview Analysis
    
    History Analysis
    
    Analysis World Map
    
    Status Codes Analysis
    
    Analysis Top URLs
    
    Services tab
    
    Services tab
    
    Documents
    
    Documents
    
    Mitigations tab
    
    RCA tab
    
    Configuration Status
    
    Configuration Status
    
    Domain tab
    
    Subdomain tab
    
    Tag tab
    
    Help, Updates & More tab
    
    Help, Updates & More tab
    
    Information
    
    Information
    
    User Manuals tab
    
    Myra Log Formats tab
    
    Myra Log Formats tab
    
    Abbreviations in the WAF log
    
    Myra IP Ranges tab
    
    Ticket center
    
    Ticket center
    
    Ticket Details
    
    Create Ticket dialog
    
    Rollback
    
    Rollback
    
    Rollback tab
    
    Rollback History tab
- Configurations
  Configurations
  - Set up Myra protection
    
    Set up Myra protection
    
    Definition of the name server
    
    Add a New Domain
    
    Add DNS Records
    
    Redirecting Traffic to Myra
    
    Add SSL/TLS certificate
    
    Activating Myra Protection
  - Using Access Logs
    
    Using Access Logs
    
    Generating ED25519 SSH key
    
    Enabling Access Logs
    
    Connecting to the Myra log server using SFTP
  - Set up Myra CDN
    
    Set up Myra CDN
    
    Enabling caching
    
    Add cache entries
    
    Checking caching
    
    Edit cache entry
    
    Delete cache entry
  - Set up Myra WAF
    
    Set up Myra WAF
    
    Enabling WAF in the subdomain settings
    
    Copying Myra Tags
    
    Add additional rules to the WAF Tag (optional)
    
    Reviewing of WAF rules
    
    Activating WAF rule
    
    Best practices for WAF rules
    
    Best practices for WAF rules
    
    Matching a URL with a query string
    
    Matching the referer
    
    Matching the country code
    
    Matching the ASN
    
    Matching the AS type
    
    Matching fingerprints
    
    Matching the path
    
    Matching a file suffix
    
    Matching encoded paths
    
    Matching an IP range
    
    Setting a cookie
    
    Rate limit via a WAF rule
    
    Setting an HTTP status and redirecting
    
    Sending information to the customer infrastructure in the header
    
    URI substitution with query strings
    
    Appending .html to all paths
  - Set up tags
    
    Set up tags
    
    Create tag
    
    Edit properties and assignment of a tag
    
    Copy tag
    
    Delete tag
  - Add SSL/TLS certificate
    
    Add SSL/TLS certificate
    
    Add SSL/TLS certificate
    
    Add SSL/TLS certificate
    
    Upload SSL/TLS certificate
    
    Myra Certificate Management
    
    Myra Certificate Management
    
    Create an SSL/TLS certificate using the Myra App
    
    Myra is the name server
    
    Myra is not the name server.
    
    Edit SSL/TLS Certificate
    
    Edit SSL/TLS Certificate
    
    Updating SSL/TLS Certificate
    
    Edit subdomain mappings
    
    Edit cipher
    
    Update SSL/TLS intermediate certificate
    
    Delete SSL/TLS Certificate
    
    Manage certification authorities
    
    Manage certification authorities
    
    Add a certification authority
    
    Edit a certification authority
    
    Delete certification authority
  - Set up a domain
    
    Set up a domain
    
    Add a domain
    
    Delete domain
  - Set up DNS records
    
    Set up DNS records
    
    Add a DNS record
    
    Edit DNS entry
    
    Delete DNS record
  - Add WebSockets
  - Set up custom error pages
    
    Set up custom error pages
    
    Add custom error pages
    
    Edit custom error pages
    
    Delete custom error pages
  - Set up IP filtering
    
    Set up IP filtering
    
    Add an IP filter
    
    Edit IP Filter
    
    Delete an IP filter
    
    Export IP filter entries
    
    Import IP filter entries
    
    Allow only IP addresses on the IP allowlist
  - Set up load balancing
    
    Set up load balancing
    
    Set up load balancing
  - Set up maintenance pages
    
    Set up maintenance pages
    
    Add a maintenance page
    
    Edit Maintenance Page
    
    Delete maintenance page
    
    Add a template for the maintenance page
    
    Edit the maintenance page template
    
    Delete a maintenance page template
  - Set up redirects
    
    Set up redirects
    
    Add a redirect
    
    Edit redirect
    
    Delete redirect
  - Set up single sign-on (SSO)
    
    Set up single sign-on (SSO)
    
    Set up SSO
    
    Testing SSO login
    
    Disable single sign-on (SSO)
  - Set up account security
  - Set up Myra Object Storage
    
    Set up Myra Object Storage
    
    Book Object Storage
    
    Generating ED25519 SSH key
    
    Uploading data via SFTP
    
    Enable Object Storage in the Myra App
    
    Enable Object Storage in the Myra App
    
    Creating a DNS entry for object storage
    
    Customize WAF rules for upstream
  - Set up Myra Waiting Room
    
    Set up Myra Waiting Room
    
    Creating waiting room
    
    Edit waiting room
    
    Delete waiting room
    
    Waiting page for the waiting room
  - Set up image scaling
    
    Set up image scaling
    
    Booking Image Scaling
    
    Enable image scaling
  - Set up notifications
- Troubleshooting
  Troubleshooting
  - Login and user account
    Login and user account
    
    Unable to log in
    
    Password expired
    
    Authentication code is not valid
    
    Current password is not correct
    
    Access denied
    
    SSO certificate invalid or expired
  - Domains and SSL/TLS certificates
    Domains and SSL/TLS certificates
    
    Domain limit reached
    
    Unable to process the certificate
    
    Private key does not match the certificate
    
    Certificate already exists
    
    The certificate has no domains assigned
  - WAF and IP filter
    WAF and IP filter
    
    WAF rule cannot be enabled
    
    IP filter entries cannot be imported
  - Maintenance page and error pages
    Maintenance page and error pages
    
    HTML file is not accepted
  - Statistics
    Statistics
    
    Too many data points
  - Ticket Center
    Ticket Center
    
    Attachment is rejected
Myra DataHub
Myra DataHub
- Description
  Description
  - What is the Myra DataHub?
- Getting Started
  Getting Started
  - Registration
- DataHub portal
  DataHub portal
  - Overview of the Myra DataHub portal
    
    Overview of the Myra DataHub portal
    
    Dashboard view
    
    Networks
    
    Networks
    
    Start manual mitigations
    
    Stop manual mitigations
    
    Mitigation history
    
    Mitigation history
    
    Mitigation reports view
    
    Open mitigation reports
    
    Traffic Reports view
    
    Audit log view
    
    Anomaly history view
  - Company management
    
    Company management
    
    Company management
    
    Company management
    
    User management tab
    
    User management tab
    
    Add account
    
    Change account
    
    SIEM Settings tab
    
    Notifications tab
  - Profile
    
    Profile
    
    Profile tab
    
    Profile tab
    
    Change username
    
    Close active web browser sessions
    
    API tokens tab
    
    Notifications tab
- Permissions
  Permissions
  - Roles and permissions
- Troubleshooting
  Troubleshooting
  - Login and user account
    Login and user account
    
    Credentials do not match
    
    Too many login attempts
    
    Email address not verified
    
    Password reset link is no longer valid
    
    Email address not linked to an account
    
    Two-factor authentication required
  - Networks and mitigations
    Networks and mitigations
    
    IP address does not belong to the network
    
    A mitigation already exists for the IP address
API
API
- General
  General
  - Using the Myra API
  - Getting access to the Myra API
    
    Getting access to the Myra API
    
    Authentication using a signature
    
    Authentication using a signature
    
    Creating API key and secret
    
    Sending a request to the API using a signature
    
    Authentication using bearer tokens
    
    Authentication using bearer tokens
    
    Creating API token
    
    Request to the API using a bearer token
  - Possible responses to a request
- Myra App API
  Myra App API
  - Used API methods
  - Important variable names
  - Initial configurations
    
    Initial configurations
    
    Set up Myra protection
    
    Set up CDN
  - API endpoints
    API endpoints
    
    Clear Cache
    Clear Cache
    
    Clearing the cache of a domain or subdomain
    
    Custom Configuration
    Custom Configuration
    
    Listing the custom configurations of a domain
    
    Getting a custom configuration
    
    Adding a custom configuration
    
    Changing a custom configuration
    
    Deleting a custom configuration
    
    DNS Records
    DNS Records
    
    Deleting a DNS record
    
    Listing all DNS records of a domain
    
    Getting a DNS record
    
    Listing all load balancing entries of a domain
    
    Listing all DNS records of a subdomain
    
    Adding a DNS record for a domain
    
    Changing a DNS record
    
    Changing the load balancing of a DNS Request
    
    Domain
    Domain
    
    Deleting a domain
    
    Listing all domains and domain configuration
    
    Listing all configuration of a domain
    
    Listing the raw bind configuration of a domain
    
    Getting the bind configuration of a domain
    
    Adding a domain
    
    Changing the configuration of a domain
    
    Domain Cache Setting
    Domain Cache Setting
    
    Deleting an entry of the cache settings of a subdomain
    
    Listing all cache settings of a subdomain
    
    Adding a cache setting entry for a subdomain
    
    Changing the cache settings of a subdomain
    
    Domain Waf Rule
    Domain Waf Rule
    
    Deleting a WAF rule
    
    Listing all WAF rules of all subdomains
    
    Listing all settings of a WAF of a subdomain
    
    Adding a WAF rule for a subdomain
    
    Changing the setting of a WAF rule of a subdomain
    
    Listing all applicable WAF rules of a subdomain
    
    Error Page
    Error Page
    
    Deleting error pages
    
    Listing all error pages of a domain
    
    Getting an error page
    
    Adding or changing error pages
    
    IP Filter
    IP Filter
    
    Deleting an IP filter entry
    
    Getting an entry of an IP filter of a subdomain
    
    Listing all IP filter entries of a subdomain
    
    Exporting all IP filter entries of a subdomain as CSV
    
    Adding an IP filter entry
    
    Importing IP filter entries for a subdomain from a CSV payload
    
    Changing the settings of an IP filter entry
    
    Maintenance
    Maintenance
    
    Deleting a maintenance page of a subdomain
    
    Listing all maintenance pages for a domain
    
    Listing all maintenance pages for a domain
    
    Adding a maintenance page to a subdomain
    
    Changing the settings of a maintenance page of a subdomain
    
    Organization Contact
    Organization Contact
    
    Deleting a contact person
    
    Listing all contact persons
    
    Creating one or more contact persons
    
    Changing a contact person
    
    Permission
    Permission
    
    Deleting a permission of a user group
    
    Deleting a permission of a user account
    
    Listing all permissions of a user group
    
    Listing all permissions of a user
    
    Adding permissions to a user group
    
    Adding permissions to a user account
    
    Redirect
    Redirect
    
    Deleting a redirect entry of a subdomain
    
    Getting the settings of a redirect entry of a subdomain
    
    Listing all redirect entries of a subdomain
    
    Adding a redirect entry for a subdomain
    
    Changing the settings of a redirect entry of a subdomain
    
    Replication DNS Zone
    Replication DNS Zone
    
    Listing all replication DNS zones
    
    Getting a replication DNS zone
    
    Adding a replication DNS zone
    
    Changing a replication DNS zone
    
    Deleting a replication DNS zone
    
    Reporting
    Reporting
    
    Deleting a traffic report
    
    Listing all traffic reports
    
    Downloading a traffic report as PDF
    
    Creating a traffic report
    
    Ssl
    Ssl
    
    Deleting an SSL/TLS certificate of a domain
    
    Deleting SSL/TLS provider credentials
    
    Deleting an SSL/TLS request
    
    Lists all SSL/TLS certificates for a domain
    
    Listing an SSL/TLS certificate of a domain
    
    Listing all SSL/TLS configurations
    
    Listing the SSL/TLS provider credentials of the organisation
    
    Getting SSL/TLS provider credentials by the specified ID
    
    Listing the certificates of the specified SSL/TLS provider credentials
    
    Listing all SSL/TLS requests
    
    Getting an SSL/TLS request
    
    Adding an SSL/TLS certificate to a domain
    
    Creating SSL/TLS provider credentials
    
    Creating a new SSL/TLS request
    
    Checking the nameserver delegation of the specified domains
    
    Updating an SSL/TLS certificate
    
    Updating SSL/TLS provider credentials
    
    Updating an SSL/TLS request
    
    Updating the SSL/TLS configuration of an SSL/TLS request
    
    Statistics
    Statistics
    
    Getting the total number of requests for all domains
    
    Getting the total amount of traffic for all domains
    
    Getting a list of cached URLs for a domain or subdomain
    
    Getting analysis for a specified chart for a domain or subdomain
    
    Getting a list of all status codes for a domain or subdomain
    
    Getting a list of the most requested URLs for a domain or subdomain
    
    Getting the total number of requests a domain or subdomain
    
    Getting analysis for a geographic request distribution for a domain or subdomain
    
    Running a statistics query for domains and subdomains
    
    Subdomain Setting
    Subdomain Setting
    
    Listing all subdomain settings of a subdomain
    
    Adding subdomain settings to a subdomain
    
    Subscriptions
    Subscriptions
    
    Deleting a traffic report subscription
    
    Listing all traffic report subscriptions
    
    Getting a traffic report subscription
    
    Creating a traffic report subscription
    
    Changing a traffic report subscription
    
    Tag
    Tag
    
    Deleting a tag
    
    Listing all tags
    
    Listing all setting of a tag
    
    Listing all tags for a subdomain
    
    Adding a tag
    
    Copying a tag
    
    Changing the settings of a tag
    
    Tag Cache Setting
    Tag Cache Setting
    
    Deleting cache settings of a tag
    
    Listing all cache settings of a tag
    
    Adding a cache setting entry for a subdomain
    
    Changing the cache settings of a tag
    
    Tag Information
    Tag Information
    
    Deleting tag information
    
    Listing all tag information of a subdomain
    
    Listing all tag information of a tag
    
    Adding tag information
    
    Changing tag information of a tag
    
    Tag Setting
    Tag Setting
    
    Listing all subdomain settings of a tag
    
    Changing the subdomain settings for a tag
    
    Tag Waf Rule
    Tag Waf Rule
    
    Deleting a WAF rule of a tag
    
    Listing all WAF rules of a tag
    
    Listing all settings of a WAF of a tag
    
    Adding a WAF rule for a tag
    
    Changing the settings of a WAF rule of a tag
    
    User
    User
    
    Deleting a user account
    
    Deleting an API key of a user account
    
    Deleting a session of a user account
    
    Listing all user accounts
    
    Getting the account information of a user account
    
    Listing all activities of a user account
    
    Listing all API keys of a user account
    
    Listing all groups assigned to a user account
    
    Getting account information of the user account
    
    Listing all organisations of the user account
    
    Creating a new user account
    
    Creating an API key
    
    Changing the password of a user account
    
    Creating a new password for a user account
    
    Resetting the password of a user account
    
    Re-authenticating the own user
    
    Switching to another organisation of the user account
    
    Changing the information of a user account
    
    User Group
    User Group
    
    Deleting a user group
    
    Removing a user account from a user group
    
    Listing all user groups
    
    Getting a user group
    
    Listing all user accounts of a user group
    
    Creating a user group
    
    Adding a user account to a user group
    
    Changing a user group
    
    Waf
    Waf
    
    Listing all actions of a WAF rule
    
    Listing of all values for the actions of a WAF rule
    
    Listing all conditions of a WAF rule
    
    Listing all matching types for the condition of a WAF rule
    
    Listing all ISO codes for countries
    
    Waiting Room
    Waiting Room
    
    Deleting a waiting room
    
    Listing all waiting rooms
    
    Listing the settings of the waiting room feature
    
    Listing all settings of a waiting room
    
    Adding a waiting room
    
    Changing the settings of a waiting room
  - Links
    Links
    
    RestAPI
    
    Myrasec-go
    
    Terraform
- DataHub API
  DataHub API
  - Used API methods
  - API endpoints
    API endpoints
    
    Organizations
    Organizations
    
    Deleting an organisation
    
    Removing a notification address from an organisation
    
    Deleting the SIEM configuration of an organisation
    
    Listing organisations with network and mitigation details
    
    Listing all organisations of the user
    
    Getting an organisation by ID
    
    Listing all mitigations of an organisation
    
    Listing all networks of an organisation
    
    Listing all users of an organisation
    
    Changing the settings of an organisation
    
    Changing the SIEM configuration of an organisation
    
    Changing users within an organisation
    
    Adding an organisation
    
    Adding a notification address to an organisation
    
    Resending the confirmation email for a notification address
    
    Adding users to the organisation
    
    Removing a user from an organisation
    
    Networks
    Networks
    
    Deleting a network from the organisation
    
    Listing all networks with their mitigation status
    
    Listing all networks of the organisation
    
    Getting a network by ID
    
    Listing all mitigations of a network
    
    Changing the settings of a network
    
    Adding a network to the organisation
    
    Starting a manual mitigation for a network
    
    Stopping the active manual mitigation of a network
    
    Triggering a resync of the networks of the organisation
    
    Mitigations
    Mitigations
    
    Listing all mitigations of the organisation
    
    Getting a mitigation by ID
    
    Getting graph data of a mitigation
    
    Stopping a manual mitigation by ID
    
    Mitigation statistics
    Mitigation statistics
    
    Listing mitigation statistics for a month
    
    Listing all months with mitigation statistics
    
    Anomalies
    Anomalies
    
    Listing all anomalies of the organisation
    
    Traffic reports
    Traffic reports
    
    Listing all months with traffic report data
    
    Getting a traffic report for a type and period
    
    Audit logs
    Audit logs
    
    Listing all audit log entries of the organisation
    
    Users
    Users
    
    Getting the account information of the authenticated user
    
    Changing the notification preference of the authenticated user
  - Links
    Links
    
    RestAPI
Reference
Reference
- Manual as PDF
- Notational conventions

Home API Myra App API Initial configurations

Myra Online Help Updated · 25 Aug 2026

Initial configurations¶

The following explains how you can perform important initial configurations of the Myra App using the API.

© 2026 Myra Security GmbH. All rights reserved. AI-generated Questions or feedback about the documentation? Write an email to info@myrasecurity.com or use our contact form. Legal notices: Imprint Privacy policy Terms and conditions Made with Material for MkDocs