cloudflare
Version:
The official TypeScript library for the Cloudflare API
40 lines • 1.48 kB
text/typescript
import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseCredentials extends APIResource {
static readonly _key: readonly ['basinCatalog', 'credentials'];
/**
* Store authentication credentials for a catalog. These credentials are used to
* authenticate with R2 storage when performing catalog operations.
*
* @example
* ```ts
* const credential =
* await client.basinCatalog.credentials.create(
* 'my-data-bucket',
* {
* account_id: '0123456789abcdef0123456789abcdef',
* token: 'your-cloudflare-api-token-here',
* },
* );
* ```
*/
create(bucketName: string, params: CredentialCreateParams, options?: RequestOptions): APIPromise<CredentialCreateResponse | null>;
}
export declare class Credentials extends BaseCredentials {
}
export type CredentialCreateResponse = unknown;
export interface CredentialCreateParams {
/**
* Path param: Identifies the account.
*/
account_id: string;
/**
* Body param: Provides the Cloudflare API token for accessing R2.
*/
token: string;
}
export declare namespace Credentials {
export { type CredentialCreateResponse as CredentialCreateResponse, type CredentialCreateParams as CredentialCreateParams, };
}
//# sourceMappingURL=credentials.d.mts.map