> ## Documentation Index > Fetch the complete documentation index at: https://docs.nebius.com/llms.txt > Use this file to discover all available pages before exploring further. # List > Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder. ## OpenAPI ````yaml https://api.nebius.cloud/openapi.json get /msp/postgresql/v1alpha1/clusters openapi: 3.0.3 info: title: Nebius API version: version not set servers: - url: https://api.nebius.cloud security: - bearerAuth: [] tags: - name: nebius.ai.v1.EndpointService - name: nebius.ai.v1.JobService - name: nebius.applications.v1alpha1.K8sReleaseService - name: nebius.audit.v2.AuditEventExportService - name: nebius.audit.v2.AuditEventService - name: nebius.billing.v1.CalculatorService - name: nebius.billing.v1alpha1.CalculatorService - name: nebius.billing.v1alpha1.OneTimeExportService - name: nebius.capacity.v1.CapacityAllowanceService - name: nebius.capacity.v1.CapacityBlockGroupService - name: nebius.capacity.v1.CapacityIntervalService - name: nebius.capacity.v1.ResourceAdviceService - name: nebius.compute.v1.DiskService - name: nebius.compute.v1.DiskSnapshotService - name: nebius.compute.v1.FilesystemService - name: nebius.compute.v1.GpuClusterService - name: nebius.compute.v1.ImageService - name: nebius.compute.v1.InstanceService - name: nebius.compute.v1.MaintenanceService - name: nebius.compute.v1.NVLInstanceGroupService - name: nebius.compute.v1.NodeService - name: nebius.compute.v1.PlatformService - name: nebius.dns.v1.RecordService - name: nebius.dns.v1.ZoneService - name: nebius.iam.v1.AccessKeyService - name: nebius.iam.v1.AccessPermitService - name: nebius.iam.v1.AuthPublicKeyService - name: nebius.iam.v1.FederatedCredentialsService - name: nebius.iam.v1.FederationCertificateService - name: nebius.iam.v1.FederationService - name: nebius.iam.v1.GroupMembershipService - name: nebius.iam.v1.GroupService - name: nebius.iam.v1.InvitationService - name: nebius.iam.v1.ProfileService - name: nebius.iam.v1.ProjectService - name: nebius.iam.v1.ServiceAccountService - name: nebius.iam.v1.SessionManagementService - name: nebius.iam.v1.StaticKeyService - name: nebius.iam.v1.TenantService - name: nebius.iam.v1.TenantUserAccountService - name: nebius.iam.v1.TenantUserAccountWithAttributesService - name: nebius.iam.v2.AccessKeyService - name: nebius.iam.v2.ProjectService - name: nebius.iam.v2.TenantService - name: nebius.kms.v1.AsymmetricCryptoService - name: nebius.kms.v1.AsymmetricKeyService - name: nebius.kms.v1.SymmetricCryptoService - name: nebius.kms.v1.SymmetricKeyService - name: nebius.logging.agentmanager.v1.VersionService - name: nebius.logging.v1.LogExportService - name: nebius.maintenance.v1alpha1.MaintenanceService - name: nebius.mk8s.v1.ClusterService - name: nebius.mk8s.v1.NodeGroupService - name: nebius.mk8s.v1alpha1.ClusterService - name: nebius.mk8s.v1alpha1.NodeGroupService - name: nebius.msp.mlflow.v1alpha1.ClusterService - name: nebius.msp.postgresql.v1alpha1.BackupService - name: nebius.msp.postgresql.v1alpha1.ClusterService - name: nebius.mysterybox.v1.PayloadService - name: nebius.mysterybox.v1.SecretService - name: nebius.mysterybox.v1.SecretVersionService - name: nebius.quotas.v1.QuotaAllowanceService - name: nebius.registry.v1.ArtifactService - name: nebius.registry.v1.RegistryService - name: nebius.storage.v1.BucketService - name: nebius.storage.v1.TransferService - name: nebius.storage.v1alpha1.TransferService - name: nebius.tunnel.v1.TunnelService - name: nebius.vpc.v1.AllocationService - name: nebius.vpc.v1.NetworkService - name: nebius.vpc.v1.PoolService - name: nebius.vpc.v1.RouteService - name: nebius.vpc.v1.RouteTableService - name: nebius.vpc.v1.SecurityGroupService - name: nebius.vpc.v1.SecurityRuleService - name: nebius.vpc.v1.SubnetService - name: nebius.vpc.v1.TargetGroupService - name: nebius.vpc.v1alpha1.AllocationService - name: nebius.vpc.v1alpha1.NetworkService - name: nebius.vpc.v1alpha1.PoolService - name: nebius.vpc.v1alpha1.ScopeService - name: nebius.vpc.v1alpha1.SubnetService paths: /msp/postgresql/v1alpha1/clusters: get: tags: - nebius.msp.postgresql.v1alpha1.ClusterService summary: List description: |- Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder. operationId: ClusterService_List parameters: - description: Identifier of IAM container to list clusters from. in: query name: parentId required: true schema: type: string - description: Specifies the maximum number of items to return in the response. in: query name: pageSize schema: format: int64 type: string - description: >- Token for pagination, allowing the retrieval of the next set of results. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/mspPostgresqlV1alpha1ListClustersResponse' description: A successful response. components: schemas: mspPostgresqlV1alpha1ListClustersResponse: properties: clusters: description: List of PostgreSQL Cluster resources. items: $ref: '#/components/schemas/mspPostgresqlV1alpha1Cluster' type: array nextPageToken: description: >- This token allows you to get the next page of results for list requests. If the number of results is larger than [ListClustersRequest.page_size], use the [next_page_token] as the value for the [ListClustersRequest.page_token] parameter in the next list request. Each subsequent list request will have its own [next_page_token] to continue paging through the results. type: string type: object mspPostgresqlV1alpha1Cluster: properties: metadata: $ref: '#/components/schemas/commonV1ResourceMetadata' spec: $ref: '#/components/schemas/mspPostgresqlV1alpha1ClusterSpec' status: $ref: '#/components/schemas/mspPostgresqlV1alpha1ClusterStatus' type: object commonV1ResourceMetadata: description: Common resource metadata. properties: createdAt: description: Timestamp indicating when the resource was created. format: date-time readOnly: true type: string id: description: Identifier for the resource, unique for its resource type. type: string labels: additionalProperties: type: string description: Labels associated with the resource. type: object name: description: Human readable name for the resource. type: string parentId: description: Identifier of the parent resource to which the resource belongs. type: string resourceVersion: description: >- Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but *not* on each change of the resource's container(s) or status). Service allows zero value or current. format: int64 type: string updatedAt: description: Timestamp indicating when the resource was last updated. format: date-time readOnly: true type: string required: - parentId type: object mspPostgresqlV1alpha1ClusterSpec: properties: backup: $ref: '#/components/schemas/v1alpha1BackupSpec' bootstrap: $ref: '#/components/schemas/v1alpha1BootstrapSpec' config: $ref: '#/components/schemas/v1alpha1ConfigSpec' description: description: Description of the PostgreSQL cluster. type: string networkId: description: Network ID in which the cluster is created. type: string required: - networkId - config - bootstrap type: object mspPostgresqlV1alpha1ClusterStatus: properties: connectionEndpoints: $ref: '#/components/schemas/mspPostgresqlV1alpha1Endpoints' phase: $ref: '#/components/schemas/ClusterStatusPhase' presetDetails: $ref: '#/components/schemas/resourcePresetDetails' state: $ref: '#/components/schemas/nebiusMspV1alpha1ClusterStatusState' type: object v1alpha1BackupSpec: properties: backupWindowStart: title: Backup window start in "HH:MM:SS" format (UTC Time) type: string retentionPolicy: title: Retention policy to be used for backups and WALs (i.e. '7d') type: string type: object v1alpha1BootstrapSpec: properties: dbName: description: Name of the PostgreSQL database. 1-63 characters long. type: string userName: description: Name of the bootstrap PostgreSQL user. type: string userPassword: description: Password of the bootstrap PostgreSQL user. type: string required: - userName - dbName type: object v1alpha1ConfigSpec: properties: poolerConfig: $ref: '#/components/schemas/v1alpha1ConnectionPoolerConfig' postgresqlConfig16: $ref: '#/components/schemas/configPostgresqlConfig16' publicAccess: description: >- Either make cluster public accessible or accessible only via private VPC. type: boolean template: $ref: '#/components/schemas/v1alpha1TemplateSpec' version: title: |- Version of PostgreSQL used in the cluster. Possible values: `16` type: string required: - version - template type: object mspPostgresqlV1alpha1Endpoints: properties: privateReadOnly: description: >- Read only endpoint of the PostgreSQL cluster accessible from the private VPC. readOnly: true type: string privateReadWrite: description: >- Read write endpoint of the PostgreSQL cluster accessible from the private VPC. readOnly: true type: string publicReadOnly: description: >- Read only endpoint of the PostgreSQL cluster accessible from the internet. readOnly: true type: string publicReadWrite: description: >- Read write endpoint of the PostgreSQL cluster accessible from the internet. readOnly: true type: string type: object ClusterStatusPhase: default: PHASE_UNSPECIFIED enum: - PHASE_UNSPECIFIED - PHASE_PROVISIONING - PHASE_RUNNING - PHASE_UPDATING - PHASE_DELETING - PHASE_DELETED - PHASE_PURGING - PHASE_STOPPING - PHASE_RESUMING type: string resourcePresetDetails: properties: cpuCount: format: int32 type: integer gpuCount: format: int32 type: integer memoryGibibytes: format: int64 type: string type: object nebiusMspV1alpha1ClusterStatusState: default: STATE_UNSPECIFIED enum: - STATE_UNSPECIFIED - STATE_IN_PROGRESS - STATE_FINISHED - STATE_ERROR - STATE_DEGRADED - STATE_SCHEDULED type: string v1alpha1ConnectionPoolerConfig: properties: maxPoolSize: description: >- Maximum number of connections in the pool for a single user/database pair. format: int64 type: string poolingMode: $ref: '#/components/schemas/ConnectionPoolerConfigPoolingMode' type: object configPostgresqlConfig16: properties: autovacuumAnalyzeScaleFactor: format: double type: number autovacuumNaptime: description: in seconds. format: int64 type: string autovacuumVacuumCostDelay: description: in milliseconds. format: int64 type: string autovacuumVacuumCostLimit: format: int64 type: string autovacuumVacuumScaleFactor: format: double type: number autovacuumWorkMem: description: in kilobytes. format: int64 type: string defaultTransactionReadOnly: type: boolean idleInTransactionSessionTimeout: description: in milliseconds. format: int64 type: string maxConnections: format: int64 type: string searchPath: type: string sharedBuffers: description: in kilobytes. format: int64 type: string statementTimeout: description: in milliseconds. format: int64 type: string type: object v1alpha1TemplateSpec: properties: disk: $ref: '#/components/schemas/v1alpha1ResourceDiskSpec' hosts: $ref: '#/components/schemas/resourceHostSpec' resources: $ref: '#/components/schemas/v1alpha1ResourceResourcesSpec' required: - resources - hosts - disk type: object ConnectionPoolerConfigPoolingMode: default: POOLING_MODE_UNSPECIFIED description: |2- - SESSION: Session pooling mode. - TRANSACTION: Transaction pooling mode. enum: - POOLING_MODE_UNSPECIFIED - SESSION - TRANSACTION type: string v1alpha1ResourceDiskSpec: properties: sizeGibibytes: format: int64 type: string type: type: string required: - type - sizeGibibytes type: object resourceHostSpec: properties: count: format: int64 type: string required: - count type: object v1alpha1ResourceResourcesSpec: properties: platform: type: string preset: type: string required: - platform - preset type: object securitySchemes: bearerAuth: description: The Authorization header expects a Bearer token. scheme: bearer type: http ````