BOborder0

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)
  • Auth
    API key in header Authorization

Query parameters

namestring

Filter by socket name

searchstring

Search strings in sockets

socket_typestring

Filter by socket type

tagstring[]

Filter by socket tags with format key:value (multiple supported. At most 3, requests with more than 5 tag filters will be rejected)

pagestring

Page number (offset pagination; ignored when cursor is supplied)

page_sizestring

Page size (maximum of 100, requests with larger value will be rejected)

cursorstring

Opaque cursor for stable pagination. When supplied, results are ordered by a unique immutable key and paged by this cursor instead of page; the response's next_cursor carries the token for the next page (empty when the scan is complete). Use this to reliably list all sockets.

Response

OK

next_cursorstring

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.

Changes

No recorded changes to this operation across all 1 revision of this API.