cloudflare
Version:
The official TypeScript library for the Cloudflare API
196 lines • 6.91 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { PagePromise, SinglePage } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseServiceBindings extends APIResource {
static readonly _key: readonly ['addressing', 'prefixes', 'serviceBindings'];
/**
* Creates a new Service Binding, routing traffic to IPs within the given CIDR to a
* service running on Cloudflare's network. **NOTE:** The first Service Binding
* created for an IP Prefix must exactly match the IP Prefix's CIDR. Subsequent
* Service Bindings may be created with a more-specific CIDR. Refer to the
* [Service Bindings Documentation](https://developers.cloudflare.com/byoip/service-bindings/)
* for compatibility details.
*
* @example
* ```ts
* const serviceBinding =
* await client.addressing.prefixes.serviceBindings.create(
* '2af39739cc4e3b5910c918468bb89828',
* {
* account_id: '258def64c72dae45f3e4c8516e2111f2',
* cidr: '192.0.2.0/24',
* service_id: '2db684ee7ca04e159946fd05b99e1bcd',
* },
* );
* ```
*/
create(prefixID: string, params: ServiceBindingCreateParams, options?: RequestOptions): APIPromise<ServiceBinding>;
/**
* List the Cloudflare services this prefix is currently bound to. Traffic sent to
* an address within an IP prefix will be routed to the Cloudflare service of the
* most-specific Service Binding matching the address. **Example:** binding
* `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare
* CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other
* IPs in the prefix to Cloudflare Magic Transit.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const serviceBinding of client.addressing.prefixes.serviceBindings.list(
* '2af39739cc4e3b5910c918468bb89828',
* { account_id: '258def64c72dae45f3e4c8516e2111f2' },
* )) {
* // ...
* }
* ```
*/
list(prefixID: string, params: ServiceBindingListParams, options?: RequestOptions): PagePromise<ServiceBindingsSinglePage, ServiceBinding>;
/**
* Delete a Service Binding
*
* @example
* ```ts
* const serviceBinding =
* await client.addressing.prefixes.serviceBindings.delete(
* '0429b49b6a5155297b78e75a44b09e14',
* {
* account_id: '258def64c72dae45f3e4c8516e2111f2',
* prefix_id: '2af39739cc4e3b5910c918468bb89828',
* },
* );
* ```
*/
delete(bindingID: string, params: ServiceBindingDeleteParams, options?: RequestOptions): APIPromise<ServiceBindingDeleteResponse>;
/**
* Fetch a single Service Binding
*
* @example
* ```ts
* const serviceBinding =
* await client.addressing.prefixes.serviceBindings.get(
* '0429b49b6a5155297b78e75a44b09e14',
* {
* account_id: '258def64c72dae45f3e4c8516e2111f2',
* prefix_id: '2af39739cc4e3b5910c918468bb89828',
* },
* );
* ```
*/
get(bindingID: string, params: ServiceBindingGetParams, options?: RequestOptions): APIPromise<ServiceBinding>;
}
export declare class ServiceBindings extends BaseServiceBindings {
}
export type ServiceBindingsSinglePage = SinglePage<ServiceBinding>;
export interface ServiceBinding {
/**
* Identifier of a Service Binding.
*/
id?: string;
/**
* IP Prefix in Classless Inter-Domain Routing format.
*/
cidr?: string;
/**
* Status of a Service Binding's deployment to the Cloudflare network
*/
provisioning?: ServiceBinding.Provisioning;
/**
* Identifier of a Service on the Cloudflare network. Available services and their
* IDs may be found in the **List Services** endpoint.
*/
service_id?: string;
/**
* Name of a service running on the Cloudflare network
*/
service_name?: string;
}
export declare namespace ServiceBinding {
/**
* Status of a Service Binding's deployment to the Cloudflare network
*/
interface Provisioning {
/**
* When a binding has been deployed to a majority of Cloudflare datacenters, the
* binding will become active and can be used with its associated service.
*/
state?: 'provisioning' | 'active' | 'magic_transit_route_missing';
}
}
export interface ServiceBindingDeleteResponse {
errors: Array<ServiceBindingDeleteResponse.Error>;
messages: Array<ServiceBindingDeleteResponse.Message>;
/**
* Whether the API call was successful.
*/
success: true;
}
export declare namespace ServiceBindingDeleteResponse {
interface Error {
code: number;
message: string;
documentation_url?: string;
source?: Error.Source;
}
namespace Error {
interface Source {
pointer?: string;
}
}
interface Message {
code: number;
message: string;
documentation_url?: string;
source?: Message.Source;
}
namespace Message {
interface Source {
pointer?: string;
}
}
}
export interface ServiceBindingCreateParams {
/**
* Path param: Identifier of a Cloudflare account.
*/
account_id: string;
/**
* Body param: IP Prefix in Classless Inter-Domain Routing format.
*/
cidr: string;
/**
* Body param: Identifier of a Service on the Cloudflare network. Available
* services and their IDs may be found in the **List Services** endpoint.
*/
service_id: string;
}
export interface ServiceBindingListParams {
/**
* Identifier of a Cloudflare account.
*/
account_id: string;
}
export interface ServiceBindingDeleteParams {
/**
* Identifier of a Cloudflare account.
*/
account_id: string;
/**
* Identifier of an IP Prefix.
*/
prefix_id: string;
}
export interface ServiceBindingGetParams {
/**
* Identifier of a Cloudflare account.
*/
account_id: string;
/**
* Identifier of an IP Prefix.
*/
prefix_id: string;
}
export declare namespace ServiceBindings {
export { type ServiceBinding as ServiceBinding, type ServiceBindingDeleteResponse as ServiceBindingDeleteResponse, type ServiceBindingsSinglePage as ServiceBindingsSinglePage, type ServiceBindingCreateParams as ServiceBindingCreateParams, type ServiceBindingListParams as ServiceBindingListParams, type ServiceBindingDeleteParams as ServiceBindingDeleteParams, type ServiceBindingGetParams as ServiceBindingGetParams, };
}
//# sourceMappingURL=service-bindings.d.mts.map