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>

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

Create Workers VPC connectivity service

client.connectivity.directory.services.create(ServiceCreateParamsparams, RequestOptionsoptions?): ServiceCreateResponse

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

Get Workers VPC connectivity service

client.connectivity.directory.services.get(stringserviceID, ServiceGetParams { account_id } params, RequestOptionsoptions?): ServiceGetResponse

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

Update Workers VPC connectivity service

client.connectivity.directory.services.update(stringserviceID, ServiceUpdateParamsparams, RequestOptionsoptions?): ServiceUpdateResponse

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 = InfraHTTPServiceConfig { host, name, type, 6 more } | InfraTCPServiceConfig { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

InfraTCPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

app_protocol?: "postgresql" | "mysql" | null

One of the following:

"postgresql"

"mysql"

created_at?: string

formatdate-time

service_id?: string

formatuuid

tcp_port?: number | null

formatint32

minimum1

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

ServiceCreateResponse = InfraHTTPServiceConfig { host, name, type, 6 more } | InfraTCPServiceConfig { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

InfraTCPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

app_protocol?: "postgresql" | "mysql" | null

One of the following:

"postgresql"

"mysql"

created_at?: string

formatdate-time

service_id?: string

formatuuid

tcp_port?: number | null

formatint32

minimum1

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

ServiceGetResponse = InfraHTTPServiceConfig { host, name, type, 6 more } | InfraTCPServiceConfig { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

InfraTCPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

app_protocol?: "postgresql" | "mysql" | null

One of the following:

"postgresql"

"mysql"

created_at?: string

formatdate-time

service_id?: string

formatuuid

tcp_port?: number | null

formatint32

minimum1

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

ServiceUpdateResponse = InfraHTTPServiceConfig { host, name, type, 6 more } | InfraTCPServiceConfig { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

created_at?: string

formatdate-time

http_port?: number | null

formatint32

minimum1

https_port?: number | null

formatint32

minimum1

service_id?: string

formatuuid

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time

InfraTCPServiceConfig { host, name, type, 6 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: "tcp" | "http"

One of the following:

"tcp"

"http"

app_protocol?: "postgresql" | "mysql" | null

One of the following:

"postgresql"

"mysql"

created_at?: string

formatdate-time

service_id?: string

formatuuid

tcp_port?: number | null

formatint32

minimum1

tls_settings?: TLSSettings | null

TLS settings for a connectivity service.

cert_verification_mode: string

TLS certificate verification mode for the connection to the origin.

• "verify_full" — verify certificate chain and hostname (default)
• "verify_ca" — verify certificate chain only, skip hostname check
• "disabled" — do not verify the server certificate at all

disabled cannot be combined with certificate_authority: a custom CA is only used to verify the server certificate.

certificate_authority?: string | null

UUID of the custom CA certificate or chain.

client_certificate?: string | null

UUID of the mTLS client certificate and private key.

updated_at?: string

formatdate-time