API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Connectivity

ConnectivityDirectory

ConnectivityDirectoryServices

List Workers VPC connectivity services

client.connectivity.directory.services.list(ServiceListParams { account_id, page, per_page, type } params, RequestOptionsoptions?): V4PagePaginationArray<ServiceListResponse { host, name, type, 5 more } >

GET/accounts/{account_id}/connectivity/directory/services

Create Workers VPC connectivity service

client.connectivity.directory.services.create(ServiceCreateParams { account_id, host, name, 3 more } params, RequestOptionsoptions?): ServiceCreateResponse { host, name, type, 5 more }

POST/accounts/{account_id}/connectivity/directory/services

Get Workers VPC connectivity service

client.connectivity.directory.services.get(stringserviceId, ServiceGetParams { account_id } params, RequestOptionsoptions?): ServiceGetResponse { host, name, type, 5 more }

GET/accounts/{account_id}/connectivity/directory/services/{service_id}

Update Workers VPC connectivity service

client.connectivity.directory.services.update(stringserviceId, ServiceUpdateParams { account_id, host, name, 3 more } params, RequestOptionsoptions?): ServiceUpdateResponse { host, name, type, 5 more }

PUT/accounts/{account_id}/connectivity/directory/services/{service_id}

Delete Workers VPC connectivity service

client.connectivity.directory.services.delete(stringserviceId, ServiceDeleteParams { account_id } params, RequestOptionsoptions?): void

DELETE/accounts/{account_id}/connectivity/directory/services/{service_id}

ModelsExpand Collapse

ServiceListResponse { host, name, type, 5 more }

host: InfraIPv4Host { ipv4, network } | InfraIPv6Host { ipv6, network } | InfraDualStackHost { ipv4, ipv6, network } | InfraHostnameHost { hostname, resolver_network }

One of the following:

InfraIPv4Host { ipv4, network }

ipv4: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host { ipv6, network }

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost { hostname, resolver_network }

hostname: string

resolver_network: ResolverNetwork { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips?: Array<string> | null

name: string

type: "http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

updated_at?: string

formatdate-time

ServiceCreateResponse { host, name, type, 5 more }

host: InfraIPv4Host { ipv4, network } | InfraIPv6Host { ipv6, network } | InfraDualStackHost { ipv4, ipv6, network } | InfraHostnameHost { hostname, resolver_network }

One of the following:

InfraIPv4Host { ipv4, network }

ipv4: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host { ipv6, network }

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost { hostname, resolver_network }

hostname: string

resolver_network: ResolverNetwork { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips?: Array<string> | null

name: string

type: "http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

updated_at?: string

formatdate-time

ServiceGetResponse { host, name, type, 5 more }

host: InfraIPv4Host { ipv4, network } | InfraIPv6Host { ipv6, network } | InfraDualStackHost { ipv4, ipv6, network } | InfraHostnameHost { hostname, resolver_network }

One of the following:

InfraIPv4Host { ipv4, network }

ipv4: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host { ipv6, network }

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost { hostname, resolver_network }

hostname: string

resolver_network: ResolverNetwork { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips?: Array<string> | null

name: string

type: "http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

updated_at?: string

formatdate-time

ServiceUpdateResponse { host, name, type, 5 more }

host: InfraIPv4Host { ipv4, network } | InfraIPv6Host { ipv6, network } | InfraDualStackHost { ipv4, ipv6, network } | InfraHostnameHost { hostname, resolver_network }

One of the following:

InfraIPv4Host { ipv4, network }

ipv4: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host { ipv6, network }

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: Network { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost { hostname, resolver_network }

hostname: string

resolver_network: ResolverNetwork { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips?: Array<string> | null

name: string

type: "http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

updated_at?: string

formatdate-time