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

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

Create Workers VPC connectivity service

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

Get Workers VPC connectivity service

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

Update Workers VPC connectivity service

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

Delete Workers VPC connectivity service

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

ModelsExpand Collapse

ServiceListResponse = object { host, name, type, 6 more } or object { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

created_at: optional string

formatdate-time

http_port: optional number

formatint32

minimum1

https_port: optional number

formatint32

minimum1

service_id: optional string

formatuuid

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

InfraTCPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

app_protocol: optional "postgresql" or "mysql"

One of the following:

"postgresql"

"mysql"

created_at: optional string

formatdate-time

service_id: optional string

formatuuid

tcp_port: optional number

formatint32

minimum1

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

ServiceCreateResponse = object { host, name, type, 6 more } or object { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

created_at: optional string

formatdate-time

http_port: optional number

formatint32

minimum1

https_port: optional number

formatint32

minimum1

service_id: optional string

formatuuid

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

InfraTCPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

app_protocol: optional "postgresql" or "mysql"

One of the following:

"postgresql"

"mysql"

created_at: optional string

formatdate-time

service_id: optional string

formatuuid

tcp_port: optional number

formatint32

minimum1

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

ServiceGetResponse = object { host, name, type, 6 more } or object { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

created_at: optional string

formatdate-time

http_port: optional number

formatint32

minimum1

https_port: optional number

formatint32

minimum1

service_id: optional string

formatuuid

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

InfraTCPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

app_protocol: optional "postgresql" or "mysql"

One of the following:

"postgresql"

"mysql"

created_at: optional string

formatdate-time

service_id: optional string

formatuuid

tcp_port: optional number

formatint32

minimum1

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

ServiceUpdateResponse = object { host, name, type, 6 more } or object { host, name, type, 6 more }

One of the following:

InfraHTTPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

created_at: optional string

formatdate-time

http_port: optional number

formatint32

minimum1

https_port: optional number

formatint32

minimum1

service_id: optional string

formatuuid

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time

InfraTCPServiceConfig object { host, name, type, 6 more }

host: object { ipv4, network } or object { ipv6, network } or object { ipv4, ipv6, network } or object { hostname, resolver_network }

One of the following:

InfraIPv4Host object { ipv4, network }

ipv4: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraIPv6Host object { ipv6, network }

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraDualStackHost object { ipv4, ipv6, network }

ipv4: string

ipv6: string

network: object { tunnel_id }

tunnel_id: string

formatuuid

InfraHostnameHost object { hostname, resolver_network }

hostname: string

resolver_network: object { tunnel_id, resolver_ips }

tunnel_id: string

formatuuid

resolver_ips: optional array of string

name: string

type: "tcp" or "http"

One of the following:

"tcp"

"http"

app_protocol: optional "postgresql" or "mysql"

One of the following:

"postgresql"

"mysql"

created_at: optional string

formatdate-time

service_id: optional string

formatuuid

tcp_port: optional number

formatint32

minimum1

tls_settings: optional object { cert_verification_mode, certificate_authority, client_certificate }

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: optional string

UUID of the custom CA certificate or chain.

client_certificate: optional string

UUID of the mTLS client certificate and private key.

updated_at: optional string

formatdate-time