> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Scaleway Instances cluster (browser session)

> Browser session authentication; RBAC permission `clusters.create`. External cloud provider mode is mandatory; kubeadm accepts only Cilium.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /org/clusters/scaleway
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts, and no operation is
    served without one. This document is published deliberately: it describes
    the contract only and carries no organisation data or credentials. Report
    security issues to security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /org/clusters/scaleway:
    post:
      tags:
        - Scaleway Clusters
      summary: Create a Scaleway Instances cluster (browser session)
      description: >-
        Browser session authentication; RBAC permission `clusters.create`.
        External cloud provider mode is mandatory; kubeadm accepts only Cilium.
      operationId: create_scaleway_cluster_browser
      parameters:
        - description: Must match the ankra_csrf browser cookie.
          in: header
          name: X-Ankra-CSRF
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScalewayClusterRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScalewayCreateClusterResponse'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission or CSRF check failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Resource not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Conflicting or unsafe lifecycle state
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Provider or internal failure
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    CreateScalewayClusterRequest:
      example:
        bastion_port: 61000
        cni: cilium
        cni_features:
          hubble: true
          wireguard_encryption: true
        control_plane_type: DEV1-M
        credential_id: 11111111-2222-4333-8444-555555555555
        distribution: k3s
        gateway_type: VPC-GW-S
        name: scw-prod
        region: fr-par
        runtime_credential_id: aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee
        ssh_key_credential_id: 99999999-8888-4777-8666-555555555555
        worker_type: DEV1-M
        zone: fr-par-1
      properties:
        bastion_port:
          default: 61000
          description: 61000, or a port from 1024 through 59999.
          type: integer
        cni:
          description: >-
            Container network. Omitted resolves to cilium on kubeadm (the
            default distribution) and flannel on k3s.
          enum:
            - flannel
            - calico
            - cilium
          type: string
        cni_features:
          $ref: '#/components/schemas/ScalewayCNIFeatures'
        control_plane_count:
          default: 1
          maximum: 9
          minimum: 1
          type: integer
        control_plane_type:
          default: DEV1-M
          type: string
        credential_id:
          type: string
          format: uuid
        criticality:
          anyOf:
            - enum:
                - production
                - staging
                - development
                - disposable
              type: string
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
        distribution:
          type: string
          enum:
            - k3s
            - kubeadm
          default: kubeadm
        environment:
          anyOf:
            - maxLength: 50
              minLength: 1
              type: string
            - type: 'null'
        etcd_node_count:
          type: integer
          default: 3
        etcd_topology:
          type: string
          enum:
            - stacked
            - external
          default: stacked
        etcd_type:
          default: DEV1-M
          type: string
        external_cloud_provider:
          const: true
          default: true
          type: boolean
        gateway_allowed_ips:
          type: array
          items:
            type: string
        gateway_type:
          default: VPC-GW-S
          type: string
        gitops_branch:
          type: string
          default: master
        gitops_credential_name:
          default: ''
          type: string
        gitops_repository:
          default: ''
          type: string
        gitops_provider:
          type: string
          enum:
            - github
            - bitbucket_cloud
          default: github
          description: >-
            GitOps provider of the repository the cluster is bootstrapped onto.
            Omitted is github, where gitops_repository is owner/name.
            bitbucket_cloud names the repository by gitops_workspace and
            gitops_repo_slug (or gitops_repository as workspace/repo_slug) and
            binds it as a Bitbucket Cloud repository.
        gitops_workspace:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Bitbucket Cloud workspace of the GitOps repository. Only with
            gitops_provider bitbucket_cloud; provided together with
            gitops_repo_slug.
        gitops_repo_slug:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Bitbucket Cloud repository slug of the GitOps repository. Only with
            gitops_provider bitbucket_cloud; provided together with
            gitops_workspace.
        include_dns:
          type: boolean
          default: true
        include_networking:
          type: boolean
          default: true
        gateway_api:
          type: boolean
          default: false
          description: >-
            Install the Kubernetes Gateway API beside Traefik's Ingress: the
            Gateway API standard CRDs, Traefik's Gateway provider with the
            traefik GatewayClass and a shared traefik-gateway Gateway in the
            traefik namespace (a plain HTTP listener that accepts routes from
            every namespace), cert-manager's Gateway support, and external-dns
            publishing of HTTPRoute hostnames. Ingress keeps working; one
            Traefik serves both. Requires include_networking.
        kubernetes_version:
          anyOf:
            - type: string
            - type: 'null'
        k3s_disabled_components:
          anyOf:
            - items:
                enum:
                  - coredns
                  - servicelb
                  - traefik
                  - local-storage
                  - metrics-server
                  - runtimes
                type: string
              type: array
            - type: 'null'
          description: >-
            k3s packaged components to keep disabled (k3s --disable), for
            example ["traefik"] on a cluster that brings its own ingress. k3s
            distribution only: the list is rendered into the server config at
            install and re-asserted by the maintenance pass, so the entries stay
            off across restarts.
          title: K3S Disabled Components
        name:
          type: string
        network_ip_range:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            CIDR for create-new mode; mutually exclusive with
            private_network_id.
        node_groups:
          anyOf:
            - items:
                $ref: '#/components/schemas/ScalewayCreateNodeGroupRequest'
              type: array
            - type: 'null'
        private_network_id:
          anyOf:
            - type: string
            - type: 'null'
        region:
          type: string
        retention_policy:
          type: string
          enum:
            - delete
            - retain
          default: retain
        runtime_credential_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
        ssh_key_credential_id:
          type: string
          format: uuid
        worker_count:
          default: 1
          maximum: 100
          minimum: 0
          type: integer
        worker_type:
          default: DEV1-M
          type: string
        zone:
          type: string
      required:
        - name
        - credential_id
        - ssh_key_credential_id
        - region
        - zone
      type: object
    ScalewayCreateClusterResponse:
      example:
        cluster_id: 11111111-2222-4333-8444-555555555555
        name: scw-prod
      properties:
        cluster_id:
          type: string
          format: uuid
        name:
          type: string
      required:
        - cluster_id
        - name
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ScalewayCNIFeatures:
      properties:
        ebpf_dataplane:
          type: boolean
          default: false
        hubble:
          type: boolean
          default: false
        kube_proxy_replacement:
          type: boolean
          default: false
        wireguard_encryption:
          type: boolean
          default: false
      type: object
    ScalewayCreateNodeGroupRequest:
      properties:
        autoscaling:
          anyOf:
            - properties:
                enabled:
                  type: boolean
                max_count:
                  type: integer
                min_count:
                  type: integer
              required:
                - enabled
                - min_count
                - max_count
              type: object
            - type: 'null'
        count:
          default: 1
          maximum: 100
          minimum: 0
          type: integer
        instance_type:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        name:
          type: string
        taints:
          items:
            $ref: '#/components/schemas/ScalewayNodeTaint'
          type: array
      required:
        - name
        - instance_type
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ScalewayNodeTaint:
      properties:
        effect:
          enum:
            - NoSchedule
            - PreferNoSchedule
            - NoExecute
          type: string
        key:
          type: string
        value:
          default: ''
          type: string
      required:
        - key
        - effect
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.