> ## 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. # Update bastion SSH allowlist > Bearer PAT authentication; RBAC permission `clusters.write`. Replaces the cluster's bastion SSH source allowlist and dispatches the bastion update that applies it: the bastion's SSH port then accepts only the listed IPv4 sources, the platform's own egress addresses and private network sources, and drops everything else. An empty list clears the allowlist. Clusters that never set one keep SSH open from anywhere. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json put /api/v1/clusters/upcloud/{cluster_id}/bastion/allowed-ips openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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: 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: 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: 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: 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: 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: /api/v1/clusters/upcloud/{cluster_id}/bastion/allowed-ips: put: tags: - UpCloud Clusters summary: Update bastion SSH allowlist description: >- Bearer PAT authentication; RBAC permission `clusters.write`. Replaces the cluster's bastion SSH source allowlist and dispatches the bastion update that applies it: the bastion's SSH port then accepts only the listed IPv4 sources, the platform's own egress addresses and private network sources, and drops everything else. An empty list clears the allowlist. Clusters that never set one keep SSH open from anywhere. operationId: update_bastion_allowed_ips_upcloud_pat parameters: - name: cluster_id in: path required: true schema: type: string format: uuid - description: PAT organisation override. in: header name: x-ankra-organisation-id required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BastionAllowedIPsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BastionAllowedIPsResponse' description: Successful response '401': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Unauthenticated '403': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Permission check failed '404': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Cluster not found '409': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: >- The cluster is not a UpCloud cluster, has no bastion, or is in a lifecycle state that refuses writes '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: >- Request validation failed: a missing list, an entry that is not an IPv4 address or CIDR, an IPv6 or 0.0.0.0/0 entry, or more than 64 entries '500': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Provider or internal failure security: - BearerAuth: [] components: schemas: BastionAllowedIPsRequest: type: object required: - bastion_allowed_ips properties: bastion_allowed_ips: type: array items: type: string maxItems: 64 description: >- The complete new allowlist: IPv4 addresses or CIDRs allowed to reach the bastion's SSH port, besides the platform's own egress addresses, which are always allowed. An empty list clears the allowlist and makes the bastion reachable from anywhere again. IPv6 and 0.0.0.0/0 entries are refused. BastionAllowedIPsResponse: type: object required: - node_id - kind - name - bastion_allowed_ips - operation_id properties: node_id: type: string description: 'The bastion (OVH: gateway) resource id.' kind: type: string description: The bastion resource kind. name: type: string description: The bastion name. bastion_allowed_ips: type: array items: type: string description: >- The stored allowlist, normalised (a bare address becomes /32, host bits are masked, duplicates dropped). Empty means the bastion accepts SSH from anywhere. operation_id: anyOf: - type: string - type: 'null' description: >- The operation that applies the list to the bastion. Null when nothing was scheduled: the list already matched, the cluster is stopped (it applies on start), or an active operation already covers the bastion. 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 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 securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.