Schema Reference

This section contains detailed documentation for complex object schemas used in API requests and responses.

• Access Control
• Acls
• Anti Affinity Groups
• Anti Affinity Groups Instances
• API Keys
• Audit
• Auth Azuread
• Auth Failure Listeners
• Auth Generic Oauth
• Auth Github
• Auth Gitlab
• Auth Google
• Authentication Methods
• Autovacuum
• Backup Config
• Backup Schedule
• Backups
• BG Writer
• Block Storage Snapshot
• Block Storage Snapshots
• Block Storage Snapshots Block Storage Volume
• Block Storage Volume
• Block Storage Volumes
• Block Storage Volumes Block Storage Snapshots
• Block Storage Volumes Instance
• Compactor
• Components
• Connection Info
• Connection Pools
• Datadog Tags
• Date Formats
• DBaaS Endpoints
• DBaaS Integration Types
• DBaaS Integration Types Settings
• DBaaS Service Types
• DBaaS Services
• DBaaS Services Integrations
• DBaaS Services Notifications
• Deploy Target
• Deploy Targets
• Deployments
• Deployments Model
• Details
• DNS Domain Records
• DNS Domains
• Elastic IPS
• Elastic IPS Healthcheck
• Email Sender
• Endpoint Types
• Export
• External Integrations
• Grafana
• Grafana Settings
• Grafana Settings Auth Azuread
• Grafana Settings Auth Generic Oauth
• Grafana Settings Auth Github
• Grafana Settings Auth Gitlab
• Grafana Settings Auth Google
• Grafana Settings Date Formats
• Grafana Settings SMTP Server
• Healthcheck
• Healthcheck Status
• IAM Roles
• IAM Roles Policy
• ICMP
• Impacts
• Index Patterns
• Index Template
• Instance
• Instance Anti Affinity Groups
• Instance Deploy Target
• Instance Elastic IPS
• Instance Instance Type
• Instance Manager
• Instance Pool
• Instance Pool Anti Affinity Groups
• Instance Pool Deploy Target
• Instance Pool Elastic IPS
• Instance Pool Instance Type
• Instance Pool Instances
• Instance Pool Private Networks
• Instance Pool Security Groups
• Instance Pool SSH Key
• Instance Pool SSH Keys
• Instance Pool Template
• Instance Pools
• Instance Pools Anti Affinity Groups
• Instance Pools Deploy Target
• Instance Pools Elastic IPS
• Instance Pools Instance Type
• Instance Pools Instances
• Instance Pools Manager
• Instance Pools Private Networks
• Instance Pools Security Groups
• Instance Pools SSH Key
• Instance Pools SSH Keys
• Instance Pools Template
• Instance Private Networks
• Instance Security Groups
• Instance Snapshots
• Instance SSH Key
• Instance SSH Keys
• Instance Template
• Instance Type
• Instance Types
• Instances
• Instances Anti Affinity Groups
• Instances Deploy Target
• Instances Elastic IPS
• Instances Instance Type
• Instances Manager
• Instances Private Networks
• Instances Security Groups
• Instances Snapshots
• Instances SSH Key
• Instances SSH Keys
• Instances Template
• Integrations
• Ism History
• Kafka
• Kafka Connect
• Kafka Connect Settings
• Kafka Rest
• Kafka Rest Settings
• Kafka Settings
• Kafka Settings Log Cleanup And Compaction
• Kubelet Image GC
• Leases
• Load Balancers
• Log Cleanup And Compaction
• Logs
• Maintenance
• Maintenance Updates
• Manager
• Metadata
• Migration
• Model
• Models
• Mysql
• Mysql Settings
• Networking
• Node States
• Node States Progress Updates
• Nodepools
• Nodepools Anti Affinity Groups
• Nodepools Deploy Target
• Nodepools Instance Pool
• Nodepools Instance Type
• Nodepools Kubelet Image GC
• Nodepools Private Networks
• Nodepools Security Groups
• Nodepools Template
• Notifications
• Oidc
• Opensearch
• Opensearch Dashboards
• Opensearch Settings
• Opensearch Settings Auth Failure Listeners
• Opensearch Settings Email Sender
• Opensearch Settings Ism History
• Opensearch Settings Search Backpressure
• Opensearch Settings Shard Indexing Pressure
• Options
• Parameters
• PG
• PG Settings
• PG Settings Autovacuum
• PG Settings BG Writer
• PG Settings Wal
• Pgbouncer
• Pgbouncer Settings
• Pglookout
• Pglookout Settings
• Plans
• Policy
• Private Networks
• Private Networks Leases
• Private Networks Options
• Products
• Products Metadata
• Progress Updates
• Prometheus URI
• Query
• Query Frontend
• Quotas
• Reference
• Result Codes
• Role
• Role Policy
• Rules
• Schema Registry
• Schema Registry Acl
• Schema Registry Settings
• Search Backpressure
• Security Group
• Security Groups
• Security Groups Rules
• Services
• Services Healthcheck
• Services Healthcheck Status
• Services Instance Pool
• Settings
• Settings Datadog Tags
• Shard Indexing Pressure
• SKS Clusters
• SKS Clusters Audit
• SMTP Server
• Snapshots
• Snapshots Export
• Snapshots Instance
• SOS Buckets Usage
• SSH Key
• SSH Keys
• Target Zone
• Template
• Templates
• Thanos
• Thanos Settings
• Thanos Settings Compactor
• Thanos Settings Query
• Thanos Settings Query Frontend
• Timescaledb
• Timescaledb Settings
• Topic Acl
• Updates
• Usage
• Users
• Users Role
• Valkey
• Valkey Settings
• Wal
• Zones