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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
deploymentId | string | null | |
networks | object[] |
get
Get a project-safe network configuration and its observed provisioning status
GET
Usage:
const result = await swirls.client.projectNetworks.get({
projectId: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
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:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | |
resources | object[] | Yes |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
projectId | string | |
provider | "tailscale" | |
isolationMode | "shared" | "dedicated" | "customer_owned" | |
desiredState | "active" | "suspended" | "destroyed" | |
observedStatus | "pending" | "provisioning" | "available" | "suspended" | "destroying" | "error" | |
providerNetworkId | string | null | |
desiredGeneration | number | |
observedGeneration | number | |
desiredChecksum | string | null | |
observedChecksum | string | null | |
ready | boolean | |
lastReconciledAt | unknown | null | |
lastErrorCode | string | null | |
lastError | string | null | |
updatedAt | unknown | |
resources | object[] |
suspend
Suspend Project Network transport while preserving its approved resources
POST
Usage:
const result = await swirls.client.projectNetworks.suspend({
projectId: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
projectId | string | |
provider | "tailscale" | |
isolationMode | "shared" | "dedicated" | "customer_owned" | |
desiredState | "active" | "suspended" | "destroyed" | |
observedStatus | "pending" | "provisioning" | "available" | "suspended" | "destroying" | "error" | |
providerNetworkId | string | null | |
desiredGeneration | number | |
observedGeneration | number | |
desiredChecksum | string | null | |
observedChecksum | string | null | |
ready | boolean | |
lastReconciledAt | unknown | null | |
lastErrorCode | string | null | |
lastError | string | null | |
updatedAt | unknown | |
resources | object[] |