Documentation menu

Get service access impact

GEThttps://api.instacloud.com/projects/{projectId}/services/{serviceId}/access/impact

Token scope: account · org · project — read-only tokens allowed.

Preview what changing a service's public access would break, without changing anything. Postgres: closing public access (public=false) lists compute services that will lose the database (on the legacy compute plane, which cannot use the private network lane, or on insta-compute but still bound to the public DATABASE_URL) plus the external clients, CI and local development that will no longer be able to connect. Advisory only — the change is never blocked.

Parameters

NameInTypeRequiredDescription
publicquerybooleanyesthe access mode being considered
projectIdpathstringyes
serviceIdpathstringyes

Responses

200

What changing a service's public access will break. Advisory: the change is never blocked on it.

FieldTypeRequiredDescription
warningsstring[]yeshuman-readable consequences of the change, most specific first; empty when nothing breaks
servicesobject[]yescompute services bound to this database that will lose their connection
services.idstringyes
services.namestringyescompute service name
services.provider"fly" | "insta-compute"noCompute plane actually backing a compute resource, derived from its provider_ref rather than its kind. Absent when it cannot be determined from the row — clients must then assert no provider rather than assume one from `kind`.
services.envNamestringyesthe env var the compute reads the database from
services.sourceNamestringyesthe credential it is bound to (DATABASE_URL | DATABASE_PRIVATE_URL)
services.reason"provider-cannot-use-private-lane" | "bound-to-public-url"yesprovider-cannot-use-private-lane: the compute runs on the legacy compute plane, which has no path to the private network lane. bound-to-public-url: an insta-compute service still bound to DATABASE_URL — rebind it to DATABASE_PRIVATE_URL and redeploy.

400

Default Response

FieldTypeRequiredDescription
errorstringyes

404

Default Response

FieldTypeRequiredDescription
errorstringyes

View as Markdown