Find available regions (TypeScript)

Gets a list of available regions for database creation.

The clients only return regions that support vector databases. To return other regions, use a direct HTTP request with the region-type query parameter.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Returns a promise that resolves to an AstraDBAvailableRegionInfo object that contains information about the available regions.

Parameters

Use the findAvailableRegions method, which belongs to the AstraAdmin class.

Method signature

async findAvailableRegions(
  options?: {
    onlyOrgEnabledRegions?: boolean,
    timeout: number | TimeoutDescriptor,
  }
): AstraAvailableRegionInfo[];

Name Type Summary

Name	Type	Summary
`options`	`AstraFindAvailableRegionsOptions`	Optional. The options for this method. See Properties of `options` for more details.

options

AstraFindAvailableRegionsOptions

Optional. The options for this method. See Properties of options for more details.

Properties of `options`
Name	Type	Summary
`onlyOrgEnabledRegions`	`boolean`	Optional. Whether to only return regions that can be used by the caller’s organization. Default: true
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout, in milliseconds, for the API request. If not provided, the corresponding `AstraAdmin` defaults apply.

Examples

The following examples demonstrate how to find available regions.

import { DataAPIClient } from "@datastax/astra-db-ts";

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  const regions = await admin.findAvailableRegions();

  console.log(regions);
})();

Client reference

For more information, see the client reference.

Find available regions (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback