SWIRLS_
ReferenceSDKClient

projectNetworks

SDK reference for projectnetworks —

listRequirements

List Project Network requirements declared by the active deployment

GET

Usage:

const result = await swirls.client.projectNetworks.listRequirements({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

Output:

FieldTypeDescription
deploymentIdstring | null
networksobject[]

get

Get a project-safe network configuration and its observed provisioning status

GET

Usage:

const result = await swirls.client.projectNetworks.get({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

configureShared

Enable or replace the approved resources in a shared-tailnet Project Network

POST

Usage:

const result = await swirls.client.projectNetworks.configureShared({
  projectId: '...',
  resources: [],
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes
resourcesobject[]Yes

Output:

FieldTypeDescription
idstring
projectIdstring
provider"tailscale"
isolationMode"shared" | "dedicated" | "customer_owned"
desiredState"active" | "suspended" | "destroyed"
observedStatus"pending" | "provisioning" | "available" | "suspended" | "destroying" | "error"
providerNetworkIdstring | null
desiredGenerationnumber
observedGenerationnumber
desiredChecksumstring | null
observedChecksumstring | null
readyboolean
lastReconciledAtunknown | null
lastErrorCodestring | null
lastErrorstring | null
updatedAtunknown
resourcesobject[]

suspend

Suspend Project Network transport while preserving its approved resources

POST

Usage:

const result = await swirls.client.projectNetworks.suspend({
  projectId: '...',
})

Input:

ParameterTypeRequiredDescription
projectIdstringYes

Output:

FieldTypeDescription
idstring
projectIdstring
provider"tailscale"
isolationMode"shared" | "dedicated" | "customer_owned"
desiredState"active" | "suspended" | "destroyed"
observedStatus"pending" | "provisioning" | "available" | "suspended" | "destroying" | "error"
providerNetworkIdstring | null
desiredGenerationnumber
observedGenerationnumber
desiredChecksumstring | null
observedChecksumstring | null
readyboolean
lastReconciledAtunknown | null
lastErrorCodestring | null
lastErrorstring | null
updatedAtunknown
resourcesobject[]

On this page