English
User Guide
Settings

Settings

Configure organization, team, security, and advanced settings.

Organization Settings

Organization Settings

Navigate to Settings > Organization to configure:

Basic Information

FieldDescription
NameOrganization display name
SlugURL identifier
TimezoneDefault timezone
LogoOrganization logo

Uptime Display Thresholds

Customize how uptime percentages are colored:

ThresholdDescriptionDefault
GreenGood status≥ 99%
YellowWarning status≥ 95%
RedCritical status< 95%

Team Management

Roles

RolePermissions
OwnerFull access, delete org, manage billing
AdminFull access except org deletion
MemberCreate/manage incidents, components
ViewerRead-only dashboard access

Custom Roles

Create custom roles with granular permissions:

  1. Navigate to Settings > Permissions
  2. Click "New Role"
  3. Configure:
    • Role name
    • Permission checkboxes by category

Inviting Team Members

  1. Navigate to Settings > Organization
  2. Click "Invite Member"
  3. Enter email and select role
  4. Send invitation

Removing Members

  1. Find the member in the team list
  2. Click "Remove"
  3. Confirm removal

API Keys

API Keys

Programmatic access to the API.

Creating an API Key

  1. Navigate to Settings > API Keys
  2. Click "New API Key"
  3. Configure:
    • Name (descriptive identifier)
    • Permissions (select specific or all)
    • Expiration (optional)
  4. Copy the key immediately - it won't be shown again

Key Format

sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Permissions

PermissionDescription
components:readRead components
components:writeCreate/update/delete components
incidents:readRead incidents
incidents:writeCreate/update incidents
config:readRead configuration
config:writeApply configuration
⚠️

Store API keys securely. Never commit them to version control.

Revoking Keys

  1. Find the key in the list
  2. Click "Revoke"
  3. Confirm - the key stops working immediately

Audit Logs

Audit Logs

Track all changes in your organization:

Viewing Logs

  1. Navigate to Settings > Audit Log
  2. Filter by:
    • Date range
    • User
    • Resource type
    • Action type

Logged Actions

  • User authentication
  • Component changes
  • Incident operations
  • Settings modifications
  • API key usage

Log Retention

Audit logs are retained for 90 days by default.

Git Sync

Git Sync

Manage infrastructure as code:

Configuration

  1. Navigate to Settings > Git Sync
  2. Configure:
    • Repository URL
    • Branch
    • Config file path
    • Authentication

Supported Providers

  • GitHub
  • GitLab
  • Bitbucket

Sync Modes

ModeDescription
ManualTrigger sync from dashboard
WebhookAuto-sync on push

See Integrations > Git Sync for details.

Templates

Create reusable templates:

Incident Templates

Pre-configured incident settings:

  1. Navigate to Settings > Templates
  2. Click "New Template"
  3. Configure:
    • Title pattern
    • Default impact
    • Components
    • Message content
  4. Save

Maintenance Templates

Templates for recurring maintenances.

Branding

Status Page Branding

Configure in each status page's settings:

  • Logo (light/dark mode)
  • Colors
  • Custom CSS

Email Branding

  1. Navigate to Settings > Email Branding
  2. Configure:
    • Logo
    • Primary color
    • Header/footer text
    • Custom styles

Notification Settings

Configure notification behavior:

Rate Limits

SettingDefault
Per subscriber5/min
Per channel10/min
Global100/min

Retry Settings

SettingDefault
Max retries3
Retry delay30s, 60s, 120s

Custom Code

⚠️

Custom code has security implications. Use carefully.

Inject custom HTML/JS into status pages:

Head Injection

Add to <head>:

  • Analytics
  • Fonts
  • Meta tags

Body Start

Add after <body>:

  • Third-party widgets

Body End

Add before </body>:

  • Scripts
  • Tracking

Profile Settings

Individual user settings:

Account

  1. Navigate to Settings > Profile
  2. Configure:
    • Display name
    • Email
    • Password
    • Profile picture

Notifications

Personal notification preferences:

  • Email digest frequency
  • Browser notifications

Sessions

View and manage active sessions:

  • See all logged-in devices
  • Revoke individual sessions
  • Revoke all sessions

Integrations

Configure external integrations:

See Integrations Guide for:

  • Datadog
  • Prometheus
  • Slack
  • And more

Data Management

Export Data

Export organization data:

curl http://localhost:3000/api/v1/config/export \
  -H "Authorization: Bearer sk_live_xxx" > config.yaml

Delete Organization

🚫

This action is irreversible and removes all data.

  1. Navigate to Settings > Organization
  2. Scroll to "Danger Zone"
  3. Click "Delete Organization"
  4. Confirm by typing organization name
  5. Enter password
  6. Delete

Related Documentation

SLAOverview