Skip to content
Cloudflare API
Start here
API Reference
Connectivity

Directory

DirectoryServices

List Workers VPC connectivity services
connectivity.directory.services.list(ServiceListParams**kwargs) -> SyncV4PagePaginationArray[ServiceListResponse]
GET/accounts/{account_id}/connectivity/directory/services
Create Workers VPC connectivity service
connectivity.directory.services.create(ServiceCreateParams**kwargs) -> ServiceCreateResponse
POST/accounts/{account_id}/connectivity/directory/services
Get Workers VPC connectivity service
connectivity.directory.services.get(strservice_id, ServiceGetParams**kwargs) -> ServiceGetResponse
GET/accounts/{account_id}/connectivity/directory/services/{service_id}
Update Workers VPC connectivity service
connectivity.directory.services.update(strservice_id, ServiceUpdateParams**kwargs) -> ServiceUpdateResponse
PUT/accounts/{account_id}/connectivity/directory/services/{service_id}
Delete Workers VPC connectivity service
connectivity.directory.services.delete(strservice_id, ServiceDeleteParams**kwargs)
DELETE/accounts/{account_id}/connectivity/directory/services/{service_id}
ModelsExpand Collapse
One of the following:
class InfraHTTPServiceConfig: …
host: InfraHTTPServiceConfigHost
One of the following:
class InfraHTTPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraHTTPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraHTTPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraHTTPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraHTTPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
created_at: Optional[datetime]
formatdate-time
http_port: Optional[int]
formatint32
minimum1
https_port: Optional[int]
formatint32
minimum1
service_id: Optional[str]
formatuuid
tls_settings: Optional[InfraHTTPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
class InfraTCPServiceConfig: …
host: InfraTCPServiceConfigHost
One of the following:
class InfraTCPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraTCPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraTCPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraTCPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraTCPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
app_protocol: Optional[Literal["postgresql", "mysql"]]
One of the following:
"postgresql"
"mysql"
created_at: Optional[datetime]
formatdate-time
service_id: Optional[str]
formatuuid
tcp_port: Optional[int]
formatint32
minimum1
tls_settings: Optional[InfraTCPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
One of the following:
class InfraHTTPServiceConfig: …
host: InfraHTTPServiceConfigHost
One of the following:
class InfraHTTPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraHTTPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraHTTPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraHTTPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraHTTPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
created_at: Optional[datetime]
formatdate-time
http_port: Optional[int]
formatint32
minimum1
https_port: Optional[int]
formatint32
minimum1
service_id: Optional[str]
formatuuid
tls_settings: Optional[InfraHTTPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
class InfraTCPServiceConfig: …
host: InfraTCPServiceConfigHost
One of the following:
class InfraTCPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraTCPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraTCPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraTCPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraTCPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
app_protocol: Optional[Literal["postgresql", "mysql"]]
One of the following:
"postgresql"
"mysql"
created_at: Optional[datetime]
formatdate-time
service_id: Optional[str]
formatuuid
tcp_port: Optional[int]
formatint32
minimum1
tls_settings: Optional[InfraTCPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
One of the following:
class InfraHTTPServiceConfig: …
host: InfraHTTPServiceConfigHost
One of the following:
class InfraHTTPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraHTTPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraHTTPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraHTTPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraHTTPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
created_at: Optional[datetime]
formatdate-time
http_port: Optional[int]
formatint32
minimum1
https_port: Optional[int]
formatint32
minimum1
service_id: Optional[str]
formatuuid
tls_settings: Optional[InfraHTTPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
class InfraTCPServiceConfig: …
host: InfraTCPServiceConfigHost
One of the following:
class InfraTCPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraTCPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraTCPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraTCPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraTCPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
app_protocol: Optional[Literal["postgresql", "mysql"]]
One of the following:
"postgresql"
"mysql"
created_at: Optional[datetime]
formatdate-time
service_id: Optional[str]
formatuuid
tcp_port: Optional[int]
formatint32
minimum1
tls_settings: Optional[InfraTCPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
One of the following:
class InfraHTTPServiceConfig: …
host: InfraHTTPServiceConfigHost
One of the following:
class InfraHTTPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraHTTPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraHTTPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraHTTPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraHTTPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraHTTPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
created_at: Optional[datetime]
formatdate-time
http_port: Optional[int]
formatint32
minimum1
https_port: Optional[int]
formatint32
minimum1
service_id: Optional[str]
formatuuid
tls_settings: Optional[InfraHTTPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time
class InfraTCPServiceConfig: …
host: InfraTCPServiceConfigHost
One of the following:
class InfraTCPServiceConfigHostInfraIPv4Host: …
ipv4: str
network: InfraTCPServiceConfigHostInfraIPv4HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraIPv6Host: …
ipv6: str
network: InfraTCPServiceConfigHostInfraIPv6HostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraDualStackHost: …
ipv4: str
ipv6: str
network: InfraTCPServiceConfigHostInfraDualStackHostNetwork
tunnel_id: str
formatuuid
class InfraTCPServiceConfigHostInfraHostnameHost: …
hostname: str
resolver_network: InfraTCPServiceConfigHostInfraHostnameHostResolverNetwork
tunnel_id: str
formatuuid
resolver_ips: Optional[List[str]]
name: str
type: Literal["tcp", "http"]
One of the following:
"tcp"
"http"
app_protocol: Optional[Literal["postgresql", "mysql"]]
One of the following:
"postgresql"
"mysql"
created_at: Optional[datetime]
formatdate-time
service_id: Optional[str]
formatuuid
tcp_port: Optional[int]
formatint32
minimum1
tls_settings: Optional[InfraTCPServiceConfigTLSSettings]

TLS settings for a connectivity service.

cert_verification_mode: str

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[str]

UUID of the custom CA certificate or chain.

client_certificate: Optional[str]

UUID of the mTLS client certificate and private key.

updated_at: Optional[datetime]
formatdate-time