Skip to content

Sencai Docs

GitHub

Select theme

Select language

User Guide
Developer Guide
- Architecture
- Local development
- Services
- Strapi backend
- Keycloak authentication
- API Manager
- Cloud Connector
- Webhook Publisher
- Git Connector
- GraphQL Gateway
- Billing Adapter
- Gamification Consumer
- Fleet agent
- Audit trail
- Marketplace
- Community Forum
- Go Backend Migration
- Action Gateway
- OPSLOOP
- API development
- API versioning
- SDK Getting Started
- API Reference
  - Overview
  - Access Review
    
    Overview
    List access-reviews
    Create a access-review
    Get a single access-review by id
    Update a access-review
    Delete a access-review
  - Access Review Item
    
    Overview
    List access-review-items
    Get a single access-review-item by id
    Delete a access-review-item
  - AccountType
    
    List account-types
    Create a account-type
    Get a single account-type by id
    Update a account-type
    Delete a account-type
  - AccountTypeUser
    
    List account-type-users
    Create a account-type-user
    Get a single account-type-user by id
    Update a account-type-user
    Delete a account-type-user
  - Agency Billing Summary
    
    Overview
    List agency-billing-summaries
  - Agent Config
    
    Overview
    List agent-configs
    Create a agent-config
    Push a configuration payload out to enrolled agents in an organisation
    Get a single agent-config by id
    Update a agent-config
    Delete a agent-config
  - Agent Metric Snapshot
    
    List agent-metric-snapshots
    Create a agent-metric-snapshot
    Get the latest metric snapshot per agent
  - Agent Policy
    
    Overview
    List agent-policies
    Create a agent-policy
    Activate an agent policy for its organisation
    Deactivate an agent policy
    Get a single agent-policy by id
    Update a agent-policy
    Delete a agent-policy
  - Agent Release
    
    Overview
    List agent-releases
    Create a agent-release
    Publish a new agent binary release (platform-admin only)
    Get a single agent-release by id
    Update a agent-release
    Delete a agent-release
    Mark a release as stable (platform-admin only)
    Promote a release to a fleet cohort's rollout ring (platform-admin only)
  - Agent Update Policy
    
    Overview
    List agent-update-policies
    Create a agent-update-policy
    Get a single agent-update-policy by id
    Pause an in-progress agent-update rollout
    Promote a staged agent-update rollout to the next ring
    Roll back an agent-update rollout to the previous stable release
    Verify the code-signing signature of the release targeted by this policy
  - AI Act Review
    
    List ai-act-reviews
    Create a ai-act-review
    Get a single ai-act-review by id
    Update a ai-act-review
    Delete a ai-act-review
  - AI Oversight Review
    
    Overview
    List ai-oversight-reviews
    Get a single ai-oversight-review by id
  - Alert Event
    
    Overview
    List alert-events
    Create a alert-event
    Get a single alert-event by id
    Update a alert-event
    Delete a alert-event
  - Alert Rule
    
    Overview
    List alert-rules
    Create a alert-rule
    Get a single alert-rule by id
    Update a alert-rule
    Delete a alert-rule
  - API Version Policy
    
    Overview
    List api-version-policies
    Create a api-version-policy
    Get a single api-version-policy by id
    Update a api-version-policy
    Delete a api-version-policy
  - Approval Request
    
    Overview
    List approval-requests
    Create a approval-request
    Get a single approval-request by id
    Update a approval-request
    Delete a approval-request
  - Audit Anchor
    
    Overview
    List audit-anchors
    Get a single audit-anchor by id
  - Audit Artifact
    
    Overview
    List audit-artifacts
    Create a audit-artifact
    Get a single audit-artifact by id
    Delete a audit-artifact
  - Audit Export
    
    Overview
    List audit-exports
    Get a single audit-export by id
  - Audit Log
    
    Overview
    List audit-logs
    Create a audit-log
    Org-scoped NIS2 compliance evidence timeline (customer self-service)
    Agency/MSP operator view of audit events for a managed tenant
    Verify hash-chain integrity over a bounded record range
    Verify the full hash-chain integrity of the audit trail
    Get a single audit-log by id
  - Auth
    
    Overview
    Pre-flight check whether an email is bound to an org with SSO enforced (F4.ENTERPRISE.02)
    Update the authenticated user's profile
  - Backup Policy
    
    List backup-policies
    Create a backup-policy
    Get a single backup-policy by id
    Update a backup-policy
    Delete a backup-policy
  - Backup Validation
    
    Overview
    List backup-validations
    Create a backup-validation
    Get a single backup-validation by id
    Update a backup-validation
    Delete a backup-validation
  - Badge Definition
    
    Overview
    List badge-definitions
    Create a badge-definition
    Get a single badge-definition by id
    Update a badge-definition
    Delete a badge-definition
  - Billing Event
    
    List billing-events
    Get a single billing-event by id
  - Billing Sync Log
    
    List billing-sync-logs
    Get a single billing-sync-log by id
  - Blueprint
    
    Overview
    List blueprints
    Create a blueprint
    Get a single blueprint by id
    Update a blueprint
    Delete a blueprint
  - Blueprint Draft
    
    Overview
    List blueprint-drafts
    Create a blueprint-draft
    Get a single blueprint-draft by id
    Update a blueprint-draft
    Delete a blueprint-draft
  - Blueprint Instance
    
    Overview
    List blueprint-instances
    Get a single blueprint-instance by id
  - Bulk Operation
    
    Overview
    List bulk-operations
    Create a bulk-operation
    Get a single bulk-operation by id
  - Business Metric Snapshot
    
    Overview
    List business-metric-snapshots
    Get a single business-metric-snapshot by id
  - Capacity Forecast
    
    Overview
    List capacity-forecasts
    Get a single capacity-forecast by id
  - cart-item
    
    List cart-items
    Create a cart-item
    Get a single cart-item by id
    Update a cart-item
    Delete a cart-item
  - CDN Distribution
    
    Overview
    List cdn-distributions
    Create a cdn-distribution
    Get a single cdn-distribution by id
    Update a cdn-distribution
    Delete a cdn-distribution
  - Cert Rotation Policy
    
    Overview
    List cert-rotation-policies
    Create a cert-rotation-policy
    Get a single cert-rotation-policy by id
    Update a cert-rotation-policy
    Delete a cert-rotation-policy
  - Change Request
    
    Overview
    List change-requests
    Create a change-request
    Get a single change-request by id
    Update a change-request
    Delete a change-request
  - Chaos Experiment
    
    Overview
    List chaos-experiments
    Create a chaos-experiment
    Get a single chaos-experiment by id
    Update a chaos-experiment
    Delete a chaos-experiment
    List chaos-monkeys
    Create a chaos-monkey
    Get a single chaos-monkey by id
    Update a chaos-monkey
  - Chaos Scenario
    
    Overview
    List chaos-scenarios
    Create a chaos-scenario
    Get a single chaos-scenario by id
    Update a chaos-scenario
    Delete a chaos-scenario
  - CIS Scan
    
    Overview
    List cis-scans
    Create a cis-scan
    Get a single cis-scan by id
    Update a cis-scan
    Delete a cis-scan
  - Cloud Asset
    
    Overview
    List cloud-assets
    Create a cloud-asset
    Get a single cloud-asset by id
    Update a cloud-asset
    Delete a cloud-asset
  - Cloud Connector Status
    
    Overview
    List cloud-connector-statuses
    Create a cloud-connector-status
    Get a single cloud-connector-status by id
    Update a cloud-connector-status
    Delete a cloud-connector-status
  - Cloud Credential
    
    Overview
    List cloud-credentials
    Create a cloud-credential
    Get a single cloud-credential by id
    Update a cloud-credential
    Delete a cloud-credential
  - Cloud Export Job
    
    Overview
    Get a single cloud-export-job by id
  - Cloud IAM Binding
    
    List cloud-iam-bindings
    Create a cloud-iam-binding
    Get a single cloud-iam-binding by id
    Update a cloud-iam-binding
    Delete a cloud-iam-binding
  - Cloud IAM Policy
    
    List cloud-iam-policies
    Create a cloud-iam-policy
    Get a single cloud-iam-policy by id
    Update a cloud-iam-policy
    Delete a cloud-iam-policy
  - Cloud IAM Role
    
    List cloud-iam-roles
    Create a cloud-iam-role
    Get a single cloud-iam-role by id
    Update a cloud-iam-role
    Delete a cloud-iam-role
  - Cloud IAM User
    
    List cloud-iam-users
    Create a cloud-iam-user
    Get a single cloud-iam-user by id
    Update a cloud-iam-user
    Delete a cloud-iam-user
  - Cloud Identity Scan
    
    Overview
    List cloud-identity-scans
    Get a single cloud-identity-scan by id
  - Cloud Import Job
    
    Overview
    Get a single cloud-import-job by id
  - Cloud Instance
    
    Overview
    List cloud-instances
    Create a cloud-instance
    Export cloud instances to Terraform (.tf) text (F4.IAC.02)
    Import existing infrastructure from a Terraform state file (F3.IMPORT.01)
    Get a single cloud-instance by id
    Update a cloud-instance
    Delete a cloud-instance
    Read-only backup status overview (proxy to cloud-connector, F2.BAK.02)
  - Cloud NAT Gateway
    
    List cloud-nat-gateways
    Create a cloud-nat-gateway
    Get a single cloud-nat-gateway by id
    Update a cloud-nat-gateway
    Delete a cloud-nat-gateway
  - Cloud Network
    
    List cloud-networks
    Create a cloud-network
    Get a single cloud-network by id
    Update a cloud-network
    Delete a cloud-network
  - Cloud Policy
    
    Overview
    List cloud-policies
    Create a cloud-policy
    Get a single cloud-policy by id
    Update a cloud-policy
    Delete a cloud-policy
  - Cloud Pricing
    
    Overview
    List cloud-pricings
  - Cloud Resource
    
    Overview
    List cloud-resources
    Create a cloud-resource
    Get a single cloud-resource by id
    Update a cloud-resource
    Delete a cloud-resource
  - Cloud Route Table
    
    List cloud-route-tables
    Create a cloud-route-table
    Get a single cloud-route-table by id
    Update a cloud-route-table
    Delete a cloud-route-table
  - Cloud Security Group
    
    List cloud-security-groups
    Create a cloud-security-group
    Get a single cloud-security-group by id
    Update a cloud-security-group
    Delete a cloud-security-group
  - Cloud Subnet
    
    List cloud-subnets
    Create a cloud-subnet
    Get a single cloud-subnet by id
    Update a cloud-subnet
    Delete a cloud-subnet
  - Cloud VPN Connection
    
    List cloud-vpn-connections
    Create a cloud-vpn-connection
    Get a single cloud-vpn-connection by id
    Update a cloud-vpn-connection
    Delete a cloud-vpn-connection
  - Cloud VPN Gateway
    
    List cloud-vpn-gateways
    Create a cloud-vpn-gateway
    Get a single cloud-vpn-gateway by id
    Update a cloud-vpn-gateway
    Delete a cloud-vpn-gateway
  - cluster
    
    List clusters
    Create a cluster
    Get a single cluster by id
    Update a cluster
    Delete a cluster
  - Code Review Request
    
    List code-review-requests
    Create a code-review-request
    Get a single code-review-request by id
  - COGS Record
    
    List cogs-records
    Create a cogs-record
    Get a single cogs-record by id
  - Command Execution Result
    
    Overview
    List command-execution-results
    Get a single command-execution-result by id
  - Compliance Control
    
    Overview
    List compliance-controls
    Create a compliance-control
    Get a single compliance-control by id
    Update a compliance-control
  - Cookie Consent
    
    Overview
    List cookie-consents
    Get a single cookie-consent by id
  - Correlation Finding
    
    List correlation-findings
    Create a correlation-finding
    Get a single correlation-finding by id
    Update a correlation-finding
    Delete a correlation-finding
  - Cost Allocation Rule
    
    Overview
    List cost-allocation-rules
    Create a cost-allocation-rule
    Get a single cost-allocation-rule by id
    Update a cost-allocation-rule
    Delete a cost-allocation-rule
  - Cost Anomaly
    
    Overview
    List cost-anomalies
    Create a cost-anomaly
    Get a single cost-anomaly by id
  - Cost Forecast
    
    Overview
    List cost-forecasts
    Get a single cost-forecast by id
  - Cost Recommendation
    
    Overview
    List cost-recommendations
    Create a cost-recommendation
  - Cost Record
    
    Overview
    List cost-records
  - Cross-Cloud Connection
    
    Overview
    List cross-cloud-connections
    Create a cross-cloud-connection
    Get a single cross-cloud-connection by id
    Update a cross-cloud-connection
    Delete a cross-cloud-connection
  - Custom Registry
    
    Overview
    List custom-registries
    Create a custom-registry
    Get a single custom-registry by id
    Update a custom-registry
    Delete a custom-registry
  - Customer Health
    
    List customer-healths
    Get a single customer-health by id
  - Customer Health Score
    
    Overview
    List customer-health-scores
    Get a single customer-health-score by id
  - Customer Webhook
    
    Overview
    List customer-webhooks
    Create a customer-webhook
    Get a single customer-webhook by id
    Update a customer-webhook
    Delete a customer-webhook
  - DDoS Posture
    
    Overview
    List ddos-postures
    Get a single ddos-posture by id
  - Deployment
    
    Overview
    List deployments
    Create a deployment
    Get a single deployment by id
    Update a deployment
    Delete a deployment
  - DNS Record
    
    Overview
    List dns-records
    Create a dns-record
    Get a single dns-record by id
    Update a dns-record
    Delete a dns-record
  - DNS Zone
    
    Overview
    List dns-zones
    Create a dns-zone
    Get a single dns-zone by id
    Update a dns-zone
    Delete a dns-zone
  - Drift Event
    
    Overview
    List drift-events
    Get a single drift-event by id
  - Edge Cache Rule
    
    Overview
    List edge-cache-rules
    Create a edge-cache-rule
    Get a single edge-cache-rule by id
    Update a edge-cache-rule
    Delete a edge-cache-rule
  - Elevation Request
    
    Overview
    List elevation-requests
    Create a elevation-request
    Get a single elevation-request by id
    Update a elevation-request
  - Email Preference
    
    Overview
    Update a email-preference
  - Escalation Policy
    
    List escalation-policies
    Create a escalation-policy
    Get a single escalation-policy by id
    Update a escalation-policy
    Delete a escalation-policy
  - Feature Flag
    
    Overview
    List feature-flags
    Create a feature-flag
    Get a single feature-flag by id
    Update a feature-flag
    Delete a feature-flag
  - Fleet Cohort
    
    Overview
    List fleet-cohorts
    Create a fleet-cohort
    Get a single fleet-cohort by id
    Update a fleet-cohort
    Delete a fleet-cohort
    Deploy (activate) a fleet cohort
  - Forum User Credential
    
    Overview
    List forum-user-credentials
    Create a forum-user-credential
    Get a single forum-user-credential by id
    Update a forum-user-credential
    Delete a forum-user-credential
  - Gamification Event
    
    Overview
    List gamification-events
    Create a gamification-event
    Get a single gamification-event by id
  - git-connector-status
    
    List git-connector-statuses
    Create a git-connector-status
    Get a single git-connector-status by id
    Update a git-connector-status
    Delete a git-connector-status
  - gitea-apps-repository
    
    List gitea-apps-repositories
    Create a gitea-apps-repository
    Get a single gitea-apps-repository by id
    Update a gitea-apps-repository
    Delete a gitea-apps-repository
  - gitea-toolbox
    
    List gitea-toolbox-icons
    Create a gitea-toolbox-icon
    Get a single gitea-toolbox-icon by id
    Update a gitea-toolbox-icon
    Delete a gitea-toolbox-icon
  - gitea-toolbox-repository
    
    List gitea-toolbox-repositories
    Create a gitea-toolbox-repository
    Get a single gitea-toolbox-repository by id
    Update a gitea-toolbox-repository
    Delete a gitea-toolbox-repository
  - Incident
    
    Overview
    List incidents
    Create a incident
    Get a single incident by id
    Update a incident
  - Integration Channel
    
    Overview
    List integration-channels
    Create a integration-channel
    Get a single integration-channel by id
    Update a integration-channel
    Delete a integration-channel
  - invoice
    
    List invoices
    Create a invoice
    Get a single invoice by id
    Update a invoice
    Delete a invoice
  - Issue Sync Config
    
    List issue-sync-configs
    Create a issue-sync-config
    Get a single issue-sync-config by id
    Update a issue-sync-config
    Delete a issue-sync-config
  - K8s Agent
    
    Overview
    List k8s-agents
    Get a single k8s-agent by id
    Delete a k8s-agent
    Get current cluster status for a Kubernetes fleet agent
  - Knowledge Article
    
    List knowledge-articles
    Create a knowledge-article
    Get a single knowledge-article by id
    Update a knowledge-article
    Delete a knowledge-article
  - Knowledge Edge
    
    Overview
    List knowledge-edges
    Get a single knowledge-edge by id
    Update a knowledge-edge
    Delete a knowledge-edge
  - Knowledge Node
    
    Overview
    List knowledge-nodes
    Get a single knowledge-node by id
    Update a knowledge-node
    Delete a knowledge-node
  - Legal Acceptance
    
    Overview
    Get a single legal-acceptance by id
  - Legal Document
    
    Overview
    List legal-documents
    Create a legal-document
    Get a single legal-document by id
    Update a legal-document
  - LLM Token Usage
    
    List llm-token-usages
    Create a llm-token-usage
  - LLM Usage
    
    List llm-usages
    Create a llm-usage
  - Lumen History
    
    List lumen-histories
    Get a single lumen-history by id
  - Lumen Recommendation
    
    List lumen-recommendations
    Get a single lumen-recommendation by id
  - Lumen Suggestion
    
    List lumen-suggestions
    Create a lumen-suggestion
    Get a single lumen-suggestion by id
  - Metering Event
    
    List metering-events
    Create a metering-event
  - MS365 Integration
    
    List ms365-integrations
    Create a ms365-integration
    Get a single ms365-integration by id
    Update a ms365-integration
    Delete a ms365-integration
  - MS365 Licence Snapshot
    
    List ms365-licence-snapshots
    Create a ms365-licence-snapshot
    Get a single ms365-licence-snapshot by id
    Update a ms365-licence-snapshot
    Delete a ms365-licence-snapshot
  - Network Policy
    
    List network-policies
    Create a network-policy
    Get a single network-policy by id
    Update a network-policy
    Delete a network-policy
  - Network Template
    
    List network-templates
    Create a network-template
    Get a single network-template by id
    Update a network-template
    Delete a network-template
  - NIS2 Gap
    
    Overview
    List nis2-gaps
    Create a nis2-gap
    Get a single nis2-gap by id
    Update a nis2-gap
    Delete a nis2-gap
  - Notification Channel
    
    Overview
    List notification-channels
    Create a notification-channel
    Get a single notification-channel by id
    Update a notification-channel
    Delete a notification-channel
  - Operator Time Entry
    
    Overview
    List operator-time-entries
    Create a operator-time-entry
    Get a single operator-time-entry by id
    Update a operator-time-entry
    Delete a operator-time-entry
  - Org Operation
    
    Overview
    List org-operations
    Get a single org-operation by id
  - Organisation
    
    Revoke a pending invitation by invitation id
    Resend an invitation email (regenerates token)
    List organisations
    Create a organisation
    Accept a pending invitation using its token (public, no auth)
    Onboard a managed organisation (agency/MSP flow)
    Get a single organisation by id
    Update a organisation
    Delete a organisation
    Get active fleet agent count for an organisation (PLG free-tier limit check)
    Org-level automation ratio with trend (F4.GAM.07)
    List pending invitations for an organisation
    Revoke a pending invitation
    Create a pending invitation for an email
    Opt-in org-scoped gamification leaderboard (F4.GAM.06)
    List members of an organisation
    Update a member's role
    Remove a member from an organisation
  - Organisation Cross-Tenant Role
    
    Overview
    List organisation-cross-tenant-roles
    Create a organisation-cross-tenant-role
    Get a single organisation-cross-tenant-role by id
    Update a organisation-cross-tenant-role
    Delete a organisation-cross-tenant-role
  - Organisation Member
    
    Overview
    List organisation-members
    Create a organisation-member
    Get a single organisation-member by id
    Update a organisation-member
    Delete a organisation-member
  - Organisation Relationship
    
    Overview
    List organisation-relationships
    Create a organisation-relationship
    Get a single organisation-relationship by id
    Update a organisation-relationship
    Delete a organisation-relationship
  - Patch Run
    
    List patch-runs
    Create a patch-run
    Get a single patch-run by id
    Update a patch-run
    Delete a patch-run
  - payment-gateway
    
    List payment-gateways
    Create a payment-gateway
    Get a single payment-gateway by id
    Update a payment-gateway
    Delete a payment-gateway
  - Platform Event
    
    List platform-events
    Get a single platform-event by id
  - Provider Image Cache
    
    Overview
    List provider-image-caches
  - purchased-service
    
    List purchased-services
    Create a purchased-service
    Get a single purchased-service by id
    Update a purchased-service
    Delete a purchased-service
  - Push Subscription
    
    Overview
    List push-subscriptions
    Create a push-subscription
    Get a single push-subscription by id
    Update a push-subscription
    Delete a push-subscription
  - Quarantine Event
    
    List quarantine-events
    Create a quarantine-event
    Get a single quarantine-event by id
    Update a quarantine-event
    Delete a quarantine-event
  - Quarantine Policy
    
    List quarantine-policies
    Create a quarantine-policy
    Get a single quarantine-policy by id
    Update a quarantine-policy
    Delete a quarantine-policy
  - Rate Limit Policy
    
    List rate-limit-policies
    Create a rate-limit-policy
    Get a single rate-limit-policy by id
    Update a rate-limit-policy
    Delete a rate-limit-policy
  - RCA Candidate
    
    List rca-candidates
    Get a single rca-candidate by id
  - Referral Link
    
    List referral-links
    Create a referral-link
    Update a referral-link
    Delete a referral-link
  - Referral Reward
    
    List referral-rewards
    Get a single referral-reward by id
    Update a referral-reward
    Delete a referral-reward
  - Region Config
    
    Overview
    List region-configs
    Create a region-config
    Get a single region-config by id
    Update a region-config
    Delete a region-config
  - Registration
    
    Overview
    List registrations
    Create a registration
    Get a single registration by id
    Update a registration
    Delete a registration
  - Remediation Rule
    
    Overview
    List remediation-rules
    Create a remediation-rule
    Get a single remediation-rule by id
    Update a remediation-rule
    Delete a remediation-rule
  - Remote Command
    
    Overview
    List remote-commands
    Create a remote-command
    Get a single remote-command by id
    Update a remote-command
    Delete a remote-command
  - Right-Sizing Recommendation
    
    Overview
    List rightsizing-recommendations
    Get a single rightsizing-recommendation by id
  - RoPA Entry
    
    List ropa-entries
    Create a ropa-entry
    Get a single ropa-entry by id
    Update a ropa-entry
    Delete a ropa-entry
  - Rotation Policy
    
    Overview
    List rotation-policies
    Create a rotation-policy
    Get a single rotation-policy by id
    Update a rotation-policy
    Delete a rotation-policy
  - Runbook
    
    Overview
    List runbooks
    Create a runbook
    Get a single runbook by id
    Update a runbook
    Delete a runbook
  - Runbook Execution
    
    Overview
    List runbook-executions
    Create a runbook-execution
  - SCIM Token
    
    List scim-tokens
    Get a single scim-token by id
    Update a scim-token
    Delete a scim-token
  - Secret Finding
    
    Overview
    List secret-findings
    Create a secret-finding
    Get a single secret-finding by id
  - Secret Injection
    
    Overview
    List secret-injections
    Create a secret-injection
    Get a single secret-injection by id
    Update a secret-injection
    Delete a secret-injection
  - Security Finding
    
    List security-findings
    Create a security-finding
    Get a single security-finding by id
    Update a security-finding
    Delete a security-finding
  - Sencai Agent
    
    Overview
    List sencai-agents
    Create a sencai-agent
    Issue a new agent enrollment token (platform-admin only)
    Get a single sencai-agent by id
    Update a sencai-agent
    Delete a sencai-agent
    Revoke an enrolled agent (org admin+)
  - shopping-cart
    
    List shopping-carts
    Get a single shopping-cart by id
  - SLA Breach
    
    List sla-breaches
    Get a single sla-breach by id
  - SLA Report
    
    List sla-reports
    Get a single sla-report by id
  - SLA Tier
    
    List sla-tiers
    Create a sla-tier
    Get a single sla-tier by id
    Update a sla-tier
    Delete a sla-tier
  - Software Inventory
    
    List software-inventories
    Create a software-inventory
    Get a single software-inventory by id
    Update a software-inventory
    Delete a software-inventory
  - Spend Cap
    
    Overview
    List spend-caps
    Create a spend-cap
    Get a single spend-cap by id
    Update a spend-cap
  - SSL Certificate
    
    Overview
    List ssl-certificates
    Create a ssl-certificate
    Get a single ssl-certificate by id
  - Subscription Enrollment
    
    List subscription-enrollments
    Create a subscription-enrollment
    Get a single subscription-enrollment by id
    Update a subscription-enrollment
    Delete a subscription-enrollment
  - Subscription Plan
    
    List subscription-plans
    Create a subscription-plan
    Get a single subscription-plan by id
    Update a subscription-plan
    Delete a subscription-plan
  - Subscription Tier
    
    List subscription-tiers
    Create a subscription-tier
    Get a single subscription-tier by id
    Update a subscription-tier
  - Support Health Snapshot
    
    List support-health-snapshots
    Create a support-health-snapshot
    Get a single support-health-snapshot by id
    Update a support-health-snapshot
    Delete a support-health-snapshot
  - Support Ticket
    
    List support-tickets
    Create a support-ticket
    Get a single support-ticket by id
    Update a support-ticket
    Delete a support-ticket
  - Synthetic Check
    
    List synthetic-checks
    Create a synthetic-check
    Get a single synthetic-check by id
    Update a synthetic-check
    Delete a synthetic-check
  - Synthetic Result
    
    List synthetic-results
    Create a synthetic-result
  - Ticket Comment
    
    List ticket-comments
    Create a ticket-comment
  - TLS Certificate
    
    Overview
    List tls-certificates
    Create a tls-certificate
    Get a single tls-certificate by id
  - Trial Activation
    
    List trial-activations
  - UAT Session
    
    Overview
    List uat-sessions
    Create a uat-session
    Get a single uat-session by id
    Update a uat-session
    Delete a uat-session
  - Usage Event
    
    List usage-events
    Get a single usage-event by id
  - Usage Metric
    
    List usage-metrics
    Get a single usage-metric by id
  - User Plan
    
    Overview
    List user-plans
    Create a user-plan
    Get a single user-plan by id
    Update a user-plan
    Delete a user-plan
  - User Rank
    
    Overview
    List user-ranks
    Create a user-rank
    Get a single user-rank by id
    Update a user-rank
    Delete a user-rank
  - User SSH Key
    
    List user-ssh-keys
    Create a user-ssh-key
    Get a single user-ssh-key by id
    Update a user-ssh-key
    Delete a user-ssh-key
  - User Subscription Enrollment
    
    Overview
    List user-subscription-enrollments
    Create a user-subscription-enrollment
    Get a single user-subscription-enrollment by id
    Update a user-subscription-enrollment
    Delete a user-subscription-enrollment
  - Vault Namespace
    
    Overview
    List vault-namespaces
    Get a single vault-namespace by id
  - Vulnerability Report
    
    Overview
    List vulnerability-reports
    Create a vulnerability-report
    Get a single vulnerability-report by id
    Update a vulnerability-report
    Delete a vulnerability-report
  - WAF ACL
    
    Overview
    List waf-acls
    Create a waf-acl
    Get a single waf-acl by id
    Update a waf-acl
    Delete a waf-acl
  - WAF Rule
    
    Overview
    List waf-rules
    Create a waf-rule
    Get a single waf-rule by id
    Update a waf-rule
    Delete a waf-rule
  - Webhook Delivery
    
    Overview
    List webhook-deliveries
    Create a webhook-delivery
    Get a single webhook-delivery by id
  - Workload Profile
    
    Overview
    List workload-profiles
    Get a single workload-profile by id
  - Workspace Group
    
    List workspace-groups
    Create a workspace-group
    Get a single workspace-group by id
    Update a workspace-group
    Delete a workspace-group
  - Workspace Licence Assignment
    
    Overview
    List licence-assignments
    Get a single licence-assignment by id
  - Workspace Licence Snapshot
    
    List workspace-licence-snapshots
    Create a workspace-licence-snapshot
    Get a single workspace-licence-snapshot by id
    Update a workspace-licence-snapshot
    Delete a workspace-licence-snapshot
  - Workspace Org Unit
    
    List workspace-org-units
    Create a workspace-org-unit
    Get a single workspace-org-unit by id
    Update a workspace-org-unit
    Delete a workspace-org-unit
  - Workspace Security Posture
    
    Overview
    List workspace-security-postures
    Get a single workspace-security-posture by id
  - Workspace Tenant
    
    Overview
    List workspace-tenants
    Create a workspace-tenant
    Get a single workspace-tenant by id
    Update a workspace-tenant
    Delete a workspace-tenant
  - Workspace User
    
    List workspace-users
    Create a workspace-user
    Get a single workspace-user by id
    Update a workspace-user
    Delete a workspace-user
  - Workspace Watchdog Event
    
    Overview
    List workspace-watchdog-events
- Contributing
- Keycloak Runbook
- Observability Stack Runbook

GitHub

Select theme

Select language

On this page

Overview
API Version Policy

Overview

API Version Policy

Section titled “API Version Policy”

Tracks API version lifecycle: current, deprecated, sunset.