> ## 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

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



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/clusters/scaleway
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: OVH Credentials
    description: OVH credentials and SSH keys.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - 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.
paths:
  /api/v1/clusters/scaleway:
    post:
      tags:
        - Scaleway Clusters
      summary: Create a Scaleway Instances cluster
      description: >-
        Bearer PAT authentication; RBAC permission `clusters.create`. External
        cloud provider mode is mandatory; kubeadm accepts only Cilium.
      operationId: create_scaleway_cluster_pat
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScalewayClusterRequest'
        required: true
      responses:
        '201':
          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:
        - BearerAuth: []
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:
          format: uuid
          type: string
        criticality:
          anyOf:
            - enum:
                - production
                - staging
                - development
                - disposable
              type: string
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
        distribution:
          default: kubeadm
          enum:
            - k3s
            - kubeadm
          type: string
        environment:
          anyOf:
            - maxLength: 50
              minLength: 1
              type: string
            - type: 'null'
        etcd_node_count:
          default: 3
          type: integer
        etcd_topology:
          default: stacked
          enum:
            - stacked
            - external
          type: string
        etcd_type:
          default: DEV1-M
          type: string
        external_cloud_provider:
          const: true
          default: true
          type: boolean
        gateway_allowed_ips:
          items:
            type: string
          type: array
        gateway_type:
          default: VPC-GW-S
          type: string
        gitops_branch:
          default: master
          type: string
        gitops_credential_name:
          default: ''
          type: string
        gitops_repository:
          default: ''
          type: string
        include_dns:
          default: true
          type: boolean
        include_networking:
          default: true
          type: boolean
        kubernetes_version:
          anyOf:
            - type: string
            - type: 'null'
        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:
          default: retain
          enum:
            - delete
            - retain
          type: string
        runtime_credential_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
        ssh_key_credential_id:
          format: uuid
          type: string
        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:
          format: uuid
          type: string
        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:
          default: false
          type: boolean
        hubble:
          default: false
          type: boolean
        kube_proxy_replacement:
          default: false
          type: boolean
        wireguard_encryption:
          default: false
          type: boolean
      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:
          additionalProperties:
            type: string
          type: object
        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

````