# Directory

# Services

## List Workers VPC connectivity services

**get** `/accounts/{account_id}/connectivity/directory/services`

List Workers VPC connectivity services

### Path Parameters

- `account_id: string`

  Account identifier

### Query Parameters

- `page: optional number`

  Current page in the response

- `per_page: optional number`

  Max amount of entries returned per page

- `type: optional "tcp" or "http"`

  - `"tcp"`

  - `"http"`

### Returns

- `errors: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `success: true`

  Whether the API call was successful.

  - `true`

- `result: optional array of  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

- `result_info: optional  { count, page, per_page, 2 more }`

  - `count: optional number`

    Total number of results for the requested service.

  - `page: optional number`

    Current page within paginated list of results.

  - `per_page: optional number`

    Number of results per page of results.

  - `total_count: optional number`

    Total results available without any search parameters.

  - `total_pages: optional number`

    The number of total pages in the entire result set.

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/connectivity/directory/services \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "host": {
        "ipv4": "10.0.0.1",
        "network": {
          "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
        }
      },
      "name": "web-app",
      "type": "http",
      "created_at": "2024-01-15T09:30:00Z",
      "http_port": 8080,
      "https_port": 8443,
      "service_id": "550e8400-e29b-41d4-a716-446655440000",
      "tls_settings": {
        "cert_verification_mode": "verify_full"
      },
      "updated_at": "2024-01-15T10:45:00Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
```

## Create Workers VPC connectivity service

**post** `/accounts/{account_id}/connectivity/directory/services`

Create Workers VPC connectivity service

### Path Parameters

- `account_id: string`

  Account identifier

### Body Parameters

- `body:  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Returns

- `errors: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `success: true`

  Whether the API call was successful.

  - `true`

- `result: optional  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/connectivity/directory/services \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "host": {
            "ipv4": "10.0.0.1",
            "network": {
              "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
            }
          },
          "name": "web-app",
          "type": "http",
          "http_port": 8080,
          "https_port": 8443
        }'
```

#### Response

```json
{
  "errors": [],
  "messages": [],
  "result": {
    "created_at": "2024-01-15T09:30:00Z",
    "host": {
      "hostname": "api.example.com",
      "resolver_network": {
        "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
      }
    },
    "name": "web-server",
    "service_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "http",
    "updated_at": "2024-01-15T09:30:00Z"
  },
  "success": true
}
```

## Get Workers VPC connectivity service

**get** `/accounts/{account_id}/connectivity/directory/services/{service_id}`

Get Workers VPC connectivity service

### Path Parameters

- `account_id: string`

- `service_id: string`

### Returns

- `errors: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `success: true`

  Whether the API call was successful.

  - `true`

- `result: optional  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/connectivity/directory/services/$SERVICE_ID \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "host": {
      "ipv4": "10.0.0.1",
      "network": {
        "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
      }
    },
    "name": "web-app",
    "type": "http",
    "created_at": "2024-01-15T09:30:00Z",
    "http_port": 8080,
    "https_port": 8443,
    "service_id": "550e8400-e29b-41d4-a716-446655440000",
    "tls_settings": {
      "cert_verification_mode": "verify_full"
    },
    "updated_at": "2024-01-15T10:45:00Z"
  }
}
```

## Update Workers VPC connectivity service

**put** `/accounts/{account_id}/connectivity/directory/services/{service_id}`

Update Workers VPC connectivity service

### Path Parameters

- `account_id: string`

- `service_id: string`

### Body Parameters

- `body:  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Returns

- `errors: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `messages: array of  { code, message, documentation_url, source }`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional  { pointer }`

    - `pointer: optional string`

- `success: true`

  Whether the API call was successful.

  - `true`

- `result: optional  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/connectivity/directory/services/$SERVICE_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "host": {
            "ipv4": "10.0.0.1",
            "network": {
              "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
            }
          },
          "name": "web-app",
          "type": "http",
          "http_port": 8080,
          "https_port": 8443
        }'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "host": {
      "ipv4": "10.0.0.1",
      "network": {
        "tunnel_id": "0191dce4-9ab4-7fce-b660-8e5dec5172da"
      }
    },
    "name": "web-app",
    "type": "http",
    "created_at": "2024-01-15T09:30:00Z",
    "http_port": 8080,
    "https_port": 8443,
    "service_id": "550e8400-e29b-41d4-a716-446655440000",
    "tls_settings": {
      "cert_verification_mode": "verify_full"
    },
    "updated_at": "2024-01-15T10:45:00Z"
  }
}
```

## Delete Workers VPC connectivity service

**delete** `/accounts/{account_id}/connectivity/directory/services/{service_id}`

Delete Workers VPC connectivity service

### Path Parameters

- `account_id: string`

- `service_id: string`

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/connectivity/directory/services/$SERVICE_ID \
    -X DELETE \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```

## Domain Types

### Service List Response

- `ServiceListResponse =  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Service Create Response

- `ServiceCreateResponse =  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Service Get Response

- `ServiceGetResponse =  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

### Service Update Response

- `ServiceUpdateResponse =  { host, name, type, 6 more }  or  { host, name, type, 6 more }`

  - `InfraHTTPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `created_at: optional string`

    - `http_port: optional number`

    - `https_port: optional number`

    - `service_id: optional string`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`

  - `InfraTCPServiceConfig  { host, name, type, 6 more }`

    - `host:  { ipv4, network }  or  { ipv6, network }  or  { ipv4, ipv6, network }  or  { hostname, resolver_network }`

      - `InfraIPv4Host  { ipv4, network }`

        - `ipv4: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraIPv6Host  { ipv6, network }`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraDualStackHost  { ipv4, ipv6, network }`

        - `ipv4: string`

        - `ipv6: string`

        - `network:  { tunnel_id }`

          - `tunnel_id: string`

      - `InfraHostnameHost  { hostname, resolver_network }`

        - `hostname: string`

        - `resolver_network:  { tunnel_id, resolver_ips }`

          - `tunnel_id: string`

          - `resolver_ips: optional array of string`

    - `name: string`

    - `type: "tcp" or "http"`

      - `"tcp"`

      - `"http"`

    - `app_protocol: optional "postgresql" or "mysql"`

      - `"postgresql"`

      - `"mysql"`

    - `created_at: optional string`

    - `service_id: optional string`

    - `tcp_port: optional number`

    - `tls_settings: optional  { cert_verification_mode }`

      TLS settings for a connectivity service.

      If omitted, the default mode (`verify_full`) is used.

      - `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

    - `updated_at: optional string`