Admin Connectivity

Generated admin connectivity operations.

GET/v1/admin/connectivity/policyRead home networks and connection settingsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_connectivity_policy

Responses

200Successapplication/json

Example

{
  "accessUrls": [
    "https://example.com/…"
  ],
  "advertiseUrl": "https://example.com/…",
  "advertisedInterface": "string",
  "connectionLimit": 0,
  "customCertificateDomain": "string",
  "customCertificateKeyPath": "string",
  "customCertificatePath": "string",
  "dlnaEnabled": true,
  "lanDiscoveryEnabled": true,
  "lanNetworks": [
    "string"
  ],
  "ownAddressEnabled": true,
  "pausedSessionTimeoutMinutes": 0,
  "remoteAccess": "string",
  "remoteBitrateLimitKbps": 0,
  "remoteSecurity": "string",
  "remoteSignInPolicy": "string",
  "revision": 0,
  "secureConnections": "string",
  "trustedProxies": [
    "string"
  ],
  "uploadCapacityKbps": 0
}

Schema

accessUrlsarray of stringrequired
advertiseUrlstringrequired
advertisedInterfacestringrequired
connectionLimitintegerrequired
customCertificateDomainstringrequired
customCertificateKeyPathstringrequired
customCertificatePathstringrequired
dlnaEnabledbooleanrequired
lanDiscoveryEnabledbooleanrequired
lanNetworksarray of stringrequired
ownAddressEnabledbooleanrequired
pausedSessionTimeoutMinutesintegerrequired
remoteAccessstringrequired
remoteBitrateLimitKbpsintegerrequired
remoteSecuritystringrequired
remoteSignInPolicystringrequired
revisionintegerrequired
secureConnectionsstringrequired
trustedProxiesarray of stringrequired
uploadCapacityKbpsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/connectivity/policy" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/admin/connectivity/policySet home networks and connection settingsadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: change_connectivity_policy
Max body: 32 KiB

Request body application/json · required

Example

{
  "accessUrls": [
    "https://example.com/…"
  ],
  "advertiseUrl": "https://example.com/…",
  "advertisedInterface": "string",
  "connectionLimit": 0,
  "customCertificateDomain": "string",
  "customCertificateKeyPath": "string",
  "customCertificatePath": "string",
  "dlnaEnabled": true,
  "expectedRevision": 0,
  "lanDiscoveryEnabled": true,
  "lanNetworks": [
    "string"
  ],
  "operationId": "id_8h2k4q",
  "ownAddressEnabled": true,
  "pausedSessionTimeoutMinutes": 0,
  "remoteAccess": "string",
  "remoteBitrateLimitKbps": 0,
  "remoteSecurity": "string",
  "remoteSignInPolicy": "string",
  "secureConnections": "string",
  "trustedProxies": [
    "string"
  ],
  "uploadCapacityKbps": 0
}

Schema

accessUrlsarray of string
advertiseUrlstring
advertisedInterfacestring
connectionLimitinteger
customCertificateDomainstring
customCertificateKeyPathstring
customCertificatePathstring
dlnaEnabledboolean
expectedRevisionintegerrequired
lanDiscoveryEnabledboolean
lanNetworksarray of string
operationIdstringrequired
ownAddressEnabledboolean
pausedSessionTimeoutMinutesinteger
remoteAccessstring
remoteBitrateLimitKbpsinteger
remoteSecuritystring
remoteSignInPolicystring
secureConnectionsstring
trustedProxiesarray of string
uploadCapacityKbpsinteger

Responses

200Successapplication/json

Example

{
  "accessUrls": [
    "https://example.com/…"
  ],
  "advertiseUrl": "https://example.com/…",
  "advertisedInterface": "string",
  "connectionLimit": 0,
  "customCertificateDomain": "string",
  "customCertificateKeyPath": "string",
  "customCertificatePath": "string",
  "dlnaEnabled": true,
  "lanDiscoveryEnabled": true,
  "lanNetworks": [
    "string"
  ],
  "ownAddressEnabled": true,
  "pausedSessionTimeoutMinutes": 0,
  "remoteAccess": "string",
  "remoteBitrateLimitKbps": 0,
  "remoteSecurity": "string",
  "remoteSignInPolicy": "string",
  "revision": 0,
  "secureConnections": "string",
  "trustedProxies": [
    "string"
  ],
  "uploadCapacityKbps": 0
}

Schema

accessUrlsarray of stringrequired
advertiseUrlstringrequired
advertisedInterfacestringrequired
connectionLimitintegerrequired
customCertificateDomainstringrequired
customCertificateKeyPathstringrequired
customCertificatePathstringrequired
dlnaEnabledbooleanrequired
lanDiscoveryEnabledbooleanrequired
lanNetworksarray of stringrequired
ownAddressEnabledbooleanrequired
pausedSessionTimeoutMinutesintegerrequired
remoteAccessstringrequired
remoteBitrateLimitKbpsintegerrequired
remoteSecuritystringrequired
remoteSignInPolicystringrequired
revisionintegerrequired
secureConnectionsstringrequired
trustedProxiesarray of stringrequired
uploadCapacityKbpsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestrevision_mismatchrequest_in_progressinternalrevision_requireddatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/admin/connectivity/policy" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accessUrls": [
    "https://example.com/…"
  ],
  "advertiseUrl": "https://example.com/…",
  "advertisedInterface": "string",
  "connectionLimit": 0,
  "customCertificateDomain": "string",
  "customCertificateKeyPath": "string",
  "customCertificatePath": "string",
  "dlnaEnabled": true,
  "expectedRevision": 0,
  "lanDiscoveryEnabled": true,
  "lanNetworks": [
    "string"
  ],
  "operationId": "id_8h2k4q",
  "ownAddressEnabled": true,
  "pausedSessionTimeoutMinutes": 0,
  "remoteAccess": "string",
  "remoteBitrateLimitKbps": 0,
  "remoteSecurity": "string",
  "remoteSignInPolicy": "string",
  "secureConnections": "string",
  "trustedProxies": [
    "string"
  ],
  "uploadCapacityKbps": 0
}'

GET/v1/admin/connectivity/refused-addressesRead the addresses outside clients asked for and were refusedadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_refused_addresses

Responses

200Successapplication/json

Example

{
  "names": [
    {
      "count": 0,
      "firstSeen": "2026-10-18T19:30:00Z",
      "lastSeen": "2026-10-18T19:30:00Z",
      "name": "Fargo",
      "reason": "string"
    }
  ],
  "remoteSecurity": "string"
}

Schema

namesarray of objectrequired
- countintegerrequired
- firstSeenstring (date-time)required
- lastSeenstring (date-time)required
- namestringrequired
- reasonstringrequired
remoteSecuritystringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/connectivity/refused-addresses" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/connectivity/refused-addresses/allowAdd a refused address to the custom addressesadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: allow_refused_address
Max body: 4 KiB

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}

Schema

expectedRevisionintegerrequired
namestringrequired
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "names": [
    {
      "count": 0,
      "firstSeen": "2026-10-18T19:30:00Z",
      "lastSeen": "2026-10-18T19:30:00Z",
      "name": "Fargo",
      "reason": "string"
    }
  ],
  "remoteSecurity": "string"
}

Schema

namesarray of objectrequired
- countintegerrequired
- firstSeenstring (date-time)required
- lastSeenstring (date-time)required
- namestringrequired
- reasonstringrequired
remoteSecuritystringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestrevision_mismatchrequest_in_progressinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/connectivity/refused-addresses/allow" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"name":"Fargo","operationId":"id_8h2k4q"}'

GET/v1/admin/connectivity/statusRead certificates and observed connection addressesadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_connectivity_status

Responses

200Successapplication/json

Example

{
  "addresses": [
    {
      "address": "string",
      "class": "string",
      "family": "string",
      "source": "string"
    }
  ],
  "connection": {
    "accessUrls": [
      "https://example.com/…"
    ],
    "clientAddress": "string",
    "lanNetworks": [
      "string"
    ],
    "plainHttpOutsideHome": true,
    "remote": true,
    "secure": true,
    "secureConnections": "string"
  },
  "discovery": {
    "detail": "string",
    "enabled": true,
    "serviceType": "string",
    "state": "string",
    "supported": true
  },
  "identityCode": "string",
  "interfaces": [
    {
      "addresses": [
        "string"
      ],
      "loopback": true,
      "name": "Fargo",
      "up": true,
      "virtual": true
    }
  ],
  "localUrl": "https://example.com/…",
  "observedAt": "2026-10-18T19:30:00Z",
  "policy": {
    "accessUrls": [
      "https://example.com/…"
    ],
    "advertiseUrl": "https://example.com/…",
    "advertisedInterface": "string",
    "connectionLimit": 0,
    "customCertificateDomain": "string",
    "customCertificateKeyPath": "string",
    "customCertificatePath": "string",
    "dlnaEnabled": true,
    "lanDiscoveryEnabled": true,
    "lanNetworks": [
      "string"
    ],
    "ownAddressEnabled": true,
    "pausedSessionTimeoutMinutes": 0,
    "remoteAccess": "string",
    "remoteBitrateLimitKbps": 0,
    "remoteSecurity": "string",
    "remoteSignInPolicy": "string",
    "revision": 0,
    "secureConnections": "string",
    "trustedProxies": [
      "string"
    ],
    "uploadCapacityKbps": 0
  },
  "tls": {
    "configured": true,
    "customCertificate": {
      "domain": "string",
      "errorCode": "string",
      "issuer": "string",
      "notAfter": "string",
      "serving": true,
      "state": "string"
    },
    "dnsName": "Fargo",
    "errorCode": "string",
    "issuer": "string",
    "listenPort": 0,
    "listenerBound": true,
    "notAfter": "string",
    "publiclyTrusted": true,
    "reachability": "string",
    "routeUrl": "https://example.com/…",
    "state": "string",
    "tlsReady": true
  },
  "warnings": [
    "string"
  ]
}

Schema

addressesarray of objectrequired
- addressstringrequired
- classstringrequired
- familystringrequired
- sourcestringrequired
connectionobjectrequired
- accessUrlsarray of stringrequired
- clientAddressstringrequired
- lanNetworksarray of stringrequired
- plainHttpOutsideHomebooleanrequired
- remotebooleanrequired
- securebooleanrequired
- secureConnectionsstringrequired
discoveryobjectrequired
- detailstring
- enabledbooleanrequired
- serviceTypestring
- statestringrequired
- supportedbooleanrequired
identityCodestring
interfacesarray of objectrequired
- addressesarray of stringrequired
- loopbackbooleanrequired
- namestringrequired
- upbooleanrequired
- virtualbooleanrequired
localUrlstring
observedAtstringrequired
policyobjectrequired
- accessUrlsarray of stringrequired
- advertiseUrlstringrequired
- advertisedInterfacestringrequired
- connectionLimitintegerrequired
- customCertificateDomainstringrequired
- customCertificateKeyPathstringrequired
- customCertificatePathstringrequired
- dlnaEnabledbooleanrequired
- lanDiscoveryEnabledbooleanrequired
- lanNetworksarray of stringrequired
- ownAddressEnabledbooleanrequired
- pausedSessionTimeoutMinutesintegerrequired
- remoteAccessstringrequired
- remoteBitrateLimitKbpsintegerrequired
- remoteSecuritystringrequired
- remoteSignInPolicystringrequired
- revisionintegerrequired
- secureConnectionsstringrequired
- trustedProxiesarray of stringrequired
- uploadCapacityKbpsintegerrequired
tlsobjectrequired
- configuredbooleanrequired
- customCertificateobject
  - domainstring
  - errorCodestring
  - issuerstring
  - notAfterstring
  - servingbooleanrequired
  - statestring
- dnsNamestring
- errorCodestring
- issuerstring
- listenPortintegerrequired
- listenerBoundbooleanrequired
- notAfterstring
- publiclyTrustedbooleanrequired
- reachabilitystring
- routeUrlstring
- statestring
- tlsReadybooleanrequired
warningsarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/connectivity/status" \
  -H "Authorization: Bearer $PORTICO_API_KEY"