API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Data Localization Suite

Data Localization SuiteRegions

List DLS regions for an account

client.dls.regions.list(RegionListParams { account_id, cursor, per_page, type } params, RequestOptionsoptions?): CursorPagination<RegionListResponse { id, created_on, modified_on, 4 more } >

GET/accounts/{account_id}/dls/regions

Get a DLS region

client.dls.regions.get(stringregionID, RegionGetParams { account_id } params, RequestOptionsoptions?): RegionGetResponse { id, created_on, modified_on, 4 more }

GET/accounts/{account_id}/dls/regions/{region_id}

ModelsExpand Collapse

RegionListResponse { id, created_on, modified_on, 4 more }

id: string

created_on: string

formatdate-time

modified_on: string

formatdate-time

name: string

region_key: string

maxLength128

minLength1

version: number

version_created_on: string

formatdate-time

RegionGetResponse { id, created_on, modified_on, 4 more }

id: string

created_on: string

formatdate-time

modified_on: string

formatdate-time

name: string

region_key: string

maxLength128

minLength1

version: number

version_created_on: string

formatdate-time

Data Localization SuiteRegional Services

Data Localization SuiteRegional ServicesPrefix Bindings

List DLS prefix bindings for an account

client.dls.regionalServices.prefixBindings.list(PrefixBindingListParams { account_id, cursor, per_page } params, RequestOptionsoptions?): CursorPagination<PrefixBindingListResponse { id, cidr, prefix_id, region_key } >

GET/accounts/{account_id}/dls/regional_services/prefix_bindings

Get a DLS prefix binding

client.dls.regionalServices.prefixBindings.get(stringbindingID, PrefixBindingGetParams { account_id } params, RequestOptionsoptions?): PrefixBindingGetResponse { id, cidr, prefix_id, region_key }

GET/accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id}

Create a DLS prefix binding

client.dls.regionalServices.prefixBindings.create(PrefixBindingCreateParams { account_id, cidr, prefix_id, region_key } params, RequestOptionsoptions?): PrefixBindingCreateResponse { id, cidr, prefix_id, region_key }

POST/accounts/{account_id}/dls/regional_services/prefix_bindings

Update a DLS prefix binding

client.dls.regionalServices.prefixBindings.edit(stringbindingID, PrefixBindingEditParams { account_id, region_key } params, RequestOptionsoptions?): PrefixBindingEditResponse { id, cidr, prefix_id, region_key }

PATCH/accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id}

Delete a DLS prefix binding

client.dls.regionalServices.prefixBindings.delete(stringbindingID, PrefixBindingDeleteParams { account_id } params, RequestOptionsoptions?): PrefixBindingDeleteResponse { messages, success, errors }

DELETE/accounts/{account_id}/dls/regional_services/prefix_bindings/{binding_id}

ModelsExpand Collapse

PrefixBindingListResponse { id, cidr, prefix_id, region_key }

id: string

The ID of the binding.

cidr: string

The CIDR that is bound.

prefix_id: string

The ID of the parent prefix.

region_key: string

The region key used for the binding.

maxLength128

minLength1

PrefixBindingGetResponse { id, cidr, prefix_id, region_key }

id: string

The ID of the binding.

cidr: string

The CIDR that is bound.

prefix_id: string

The ID of the parent prefix.

region_key: string

The region key used for the binding.

maxLength128

minLength1

PrefixBindingCreateResponse { id, cidr, prefix_id, region_key }

id: string

The ID of the binding.

cidr: string

The CIDR that is bound.

prefix_id: string

The ID of the parent prefix.

region_key: string

The region key used for the binding.

maxLength128

minLength1

PrefixBindingEditResponse { id, cidr, prefix_id, region_key }

id: string

The ID of the binding.

cidr: string

The CIDR that is bound.

prefix_id: string

The ID of the parent prefix.

region_key: string

The region key used for the binding.

maxLength128

minLength1

PrefixBindingDeleteResponse { messages, success, errors }

messages: Array<Message>

code: number

minimum1000

message: string

error_chain?: Array<unknown>

Optional upstream error context for APIv4 errors that wrap downstream service failures.

success: boolean

errors?: Array<Error>

maxLength0

code: number

minimum1000

message: string

error_chain?: Array<unknown>

Optional upstream error context for APIv4 errors that wrap downstream service failures.