Review location and access changes before adding a membership
POST
/v1/resource-locations/{resourceType}/{resourceId}/previewOrganization-scoped PostgreSQL control plane. Requires resources:write plus resource and destination authorization. No execution or credential grant. Inaccessible resources return 404; stale previews return 409; unavailable storage returns 503.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| resourceType | path | string | Yes | — |
| resourceId | path | string | Yes | — |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| containerType | project | resource_package | Yes | — |
| containerId | string | Yes | — |
| access | reference | view | Yes | Reference leaves access unchanged. View requires sharing authority and review. Packages require view. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Authorized Locations result. Only visible rows are returned; continue nextCursor even after an empty page.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| target | object | Yes | — |
| target.containerType | project | resource_package | Yes | — |
| target.containerId | string | Yes | — |
| target.access | reference | view | Yes | Reference leaves access unchanged. View requires sharing authority and review. Packages require view. |
| target.name | string | Yes | Human-readable name. |
| revision | string | Yes | — |
| confirmation | string | Yes | — |
| source | object | Yes | — |
| source.resourceType | string | Yes | — |
| source.resourceId | string | Yes | — |
| source.name | string | Yes | Human-readable name. |
| source.kind | string | Yes | — |
| notice | string | Yes | — |
| requiresConfirmation | boolean | Yes | — |
400Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
401Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
403Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
404Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
409Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
500Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
503Invalid input (400), authentication (401), denied action (403), unavailable resource (404), stale review or managed resource (409), internal failure (500), or PostgreSQL unavailable (503). No inaccessible resource identity is disclosed.application/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | Yes | — |
| code | string | No | — |
| message | string | Yes | Message text. |
Review location and access changes before adding a membership
Loading...
Response 200
Loading...