---
title: "List sockets with details incl. socket id, type, connectors, and tags."
method: GET
path: "/sockets"
---

# List sockets with details incl. socket id, type, connectors, and tags.

`GET /sockets`

## Request

- Base URL: `https://api.border0.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.border0.com/sockets`
- Auth: API key in header `Authorization`

## Query parameters

- `name` string
- `search` string
- `socket_type` string
- `tag` string[]
- `page` string
- `page_size` string
- `cursor` string

## Response `200`

OK

- SerializerPaginatedSocket
  - `list` SerializerSocket[]
    - `alive` boolean
    - `autocreation_rule_id` integer
    - `cloud_authentication_email_allowed_addressses` string[]
    - `cloud_authentication_email_allowed_domains` string[]
    - `cloud_authentication_enabled` boolean
    - `connector_authentication_enabled` boolean
    - `connector_managed` boolean
    - `connectors` SerializerSlimConnector[]
      - `connector_id` string
      - `name` string
      - `public_ips` SerializerPublicIP[]
        - `ip` string
        - `metadata` MetadataIPMetadata
          - `city_name` string
          - `country_code` string
          - `country_name` string
          - `isp` string
          - `latitude` number
          - `longitude` number
          - `region_code` string
          - `region_name` string
    - `custom_domains` string[]
    - `description` string
    - `display_name` string
    - `dnsname` string
    - `end_to_end_encryption_enabled` boolean
    - `messages` SerializerMessage[]
      - `level` string
      - `text` string
      - `type` string
    - `name` string
    - `org_custom_domain` string
    - `policies` SerializerPolicy[]
      - `created_at` string
      - `deleted` boolean
      - `description` string
      - `expires` boolean
      - `expires_at` string
      - `id` string
      - `messages` SerializerMessage[]
        - `level` string
        - `text` string
        - `type` string
      - `name` string
      - `org_id` string
      - `org_wide` boolean
      - `policy_data` DatatypesJSONMap
      - `read_only` boolean
      - `socket_ids` string[]
      - `tag_rules` object[]
      - `version` string
    - `private_network_enabled` boolean
    - `private_network_ipv4` string
    - `private_network_ipv6` string
    - `private_socket` boolean
    - `protected_password` string
    - `protected_socket` boolean
    - `protected_username` string
    - `recording_enabled` boolean
    - `socket_id` string
    - `socket_tcp_ports` integer[]
    - `socket_type` string
    - `ssh_ca` string
    - `sshkey` string
    - `tags` object
    - `tunnels` SerializerTunnel[]
      - `local_port` integer
      - `tunnel_id` string
      - `tunnel_server` string
    - `upstream_ca` string
    - `upstream_cert` string
    - `upstream_http_hostname` string
    - `upstream_key` string
    - `upstream_password` string
    - `upstream_type` string
    - `upstream_username` string
    - `user_name` string
  - `next_cursor` string: NextCursor is set only for cursor-based pagination. It is an opaque, URL-safe token to be passed back as the `cursor` query param to fetch the next page; empty when there are no more pages. Omitted entirely from legacy offset-based responses so they are unchanged.
  - `pagination` ModelsPaginationResult
    - `actual_page_size` integer
    - `current_page` integer
    - `next_page` integer
    - `records_per_page` integer
    - `total_pages` integer
    - `total_records` integer

## Other responses

- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/border0/apis/border0-api.md) - [All operations](https://skmtc.dev/border0/apis/border0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/border0/apis/border0-api/revisions/f0ccef7418d8?raw)