mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Ctrlplane",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg"
  },
  "favicon": "/favicon.png",
  "background": {
    "style": "grid"
  },
  "colors": {
    "primary": "#6B46C1",
    "light": "#805AD5",
    "dark": "#553C9A",
    "anchors": {
      "from": "#6B46C1",
      "to": "#805AD5"
    }
  },
  "openapi": "https://raw.githubusercontent.com/ctrlplanedev/ctrlplane/refs/heads/main/openapi.v1.json",
  "topbarLinks": [
    {
      "name": "Support",
      "url": "mailto:support@ctrlplane.dev"
    }
  ],
  "topbarCtaButton": {
    "name": "Dashboard",
    "url": "https://app.ctrlplane.dev"
  },
  "api": {
    "baseUrl": "https://api.ctrlplane.dev/api",
    "auth": {
      "method": "key",
      "name": "x-api-key"
    }
  },
  "tabs": [
    {
      "name": "Documentation",
      "url": "documentation"
    },
    {
      "name": "Integrations",
      "url": "integrations"
    },
    {
      "name": "Examples",
      "url": "examples"
    },
    {
      "name": "Self-Hosted",
      "url": "self-hosted"
    },
    {
      "name": "API Reference",
      "url": "api-reference"
    }
  ],
  "anchors": [
    {
      "name": "GitHub",
      "icon": "github",
      "url": "https://github.com/ctrlplanedev"
    },
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://ctrlplane.dev/discord"
    }
  ],
  "navigation": [
    {
      "group": "Get Started",
      "pages": [
        "overview",
        "introduction",
        {
          "group": "First Deployment",
          "pages": [
            "getting-started/first-deployment",
            "getting-started/approvals",
            "getting-started/define-and-use-variables"
          ]
        },
        {
          "group": "Comparisons",
          "pages": ["comparisons/overview", "comparisons/use-cases"]
        },
        "roadmap"
      ]
    },
    {
      "group": "API Documentation",
      "pages": ["api-reference/introduction"]
    },
    {
      "group": "API Reference",
      "pages": [
        {
          "group": "Environments",
          "pages": [
            "api-reference/endpoints/create-an-environment",
            "api-reference/endpoints/get-an-environment",
            "api-reference/endpoints/delete-an-environment",
            "api-reference/endpoints/delete-an-environment-by-name"
          ]
        },
        {
          "group": "Workspaces",
          "pages": [
            "api-reference/endpoints/get-a-workspace",
            "api-reference/endpoints/get-a-workspace-by-slug"
          ]
        },
        {
          "group": "Systems",
          "pages": [
            "api-reference/endpoints/create-a-system",
            "api-reference/endpoints/get-a-system",
            "api-reference/endpoints/update-a-system",
            "api-reference/endpoints/delete-a-system"
          ]
        },
        {
          "group": "Resources",
          "pages": [
            "api-reference/endpoints/create-or-update-multiple-resources",
            "api-reference/endpoints/get-a-resource",
            "api-reference/endpoints/get-a-resource-by-identifier",
            "api-reference/endpoints/update-a-resource",
            "api-reference/endpoints/delete-a-resource",
            "api-reference/endpoints/delete-a-resource-by-identifier",
            "api-reference/endpoints/sets-the-resource-for-a-provider"
          ]
        },
        {
          "group": "Resource Relationships",
          "pages": [
            "api-reference/endpoints/resource-relationships/create-a-relationship-between-two-resources",
            "api-reference/endpoints/create-a-relationship-between-a-job-and-a-resource"
          ]
        },
        {
          "group": "Releases",
          "pages": [
            "api-reference/endpoints/upserts-a-release",
            "api-reference/endpoints/updates-a-release",
            "api-reference/endpoints/create-a-release-channel",
            "api-reference/endpoints/delete-a-release-channel"
          ]
        },
        {
          "group": "Jobs",
          "pages": [
            "api-reference/endpoints/get-a-job",
            "api-reference/endpoints/update-a-job",
            "api-reference/endpoints/acknowledge-a-job",
            "api-reference/endpoints/acknowledge-a-job-for-an-agent",
            "api-reference/endpoints/get-the-next-jobs",
            "api-reference/endpoints/get-a-agents-running-jobs"
          ]
        },
        {
          "group": "Agents",
          "pages": ["api-reference/endpoints/upserts-the-agent"]
        }
      ]
    },
    {
      "group": "Cloud Providers",
      "pages": [
        "integrations/cloud-providers/overview",
        "integrations/cloud-providers/aws",
        "integrations/cloud-providers/google",
        "integrations/cloud-providers/azure"
      ]
    },
    {
      "group": "SaaS Integrations",
      "pages": [
        "integrations/saas/github",
        "integrations/saas/tailscale",
        "integrations/saas/terraform-cloud",
        "integrations/saas/clickhouse"
      ]
    },
    {
      "group": "Miscellaneous",
      "pages": ["integrations/miscellaneous/script-executor"]
    },
    {
      "group": "Simple",
      "pages": ["examples/simple/otel-deployment"]
    },
    {
      "group": "Advanced",
      "pages": ["examples/advanced/ephemeral-environments"]
    },
    {
      "group": "Concepts",
      "pages": [
        "concepts/systems",
        "concepts/resources",
        "concepts/runbooks",
        "concepts/jobs",
        "concepts/job-agents",
        "concepts/deployments",
        "concepts/releases",
        "concepts/environments"
      ]
    },
    {
      "group": "Install",
      "pages": [
        "self-hosted/install/docker",
        "self-hosted/install/kubernetes",
        {
          "group": "Terraform",
          "pages": ["self-hosted/install/terraform/google"]
        }
      ]
    },
    {
      "group": "Configuration",
      "pages": [
        "self-hosted/config/postgresql",
        {
          "group": "Authentication",
          "pages": [
            "self-hosted/config/auth/basic",
            "self-hosted/config/auth/google",
            "self-hosted/config/auth/oidc"
          ]
        },
        {
          "group": "Integrations",
          "pages": [
            "self-hosted/config/integrations/github-bot",
            "self-hosted/config/integrations/aws",
            "self-hosted/config/integrations/google",
            "self-hosted/config/integrations/azure"
          ]
        }
      ]
    },
    {
      "group": "Policies",
      "pages": [
        "policies/resource-filtering",
        "policies/governanace",
        "policies/deployment-control",
        "policies/release-management",
        "policies/release-channels",
        "policies/rollout"
      ]
    }
  ],
  "footerSocials": {
    "github": "https://github.com/ctrlplanedev",
    "linkedin": "https://linkedin.com/company/ctrlplanedev"
  }
}