Assistant

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Show one network through the read-only resource layer

GET
/scopes/{scopeId}/assistant/resources/network/{resourceId}

read-only resource layer (Cloud Shell network show <id>). Reads one resource back through the edge with the CALLER's own credential from the existing detail route and projects it onto the network list + detail columns. An upstream 401/403/404 is relayed verbatim (a resource of another project is 404, never disclosed). Validation: resourceId must match ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$ -> 422 (nothing is read back); READ on network -> 403; unreachable scope -> 404. Feature flag: 404 while the assistant service is disabled. Async & state: Synchronous read; no state change. GET only. Errors: 401; 403; 404; 422; 429; 500; 503 when the upstream route cannot be reached. Idempotency/Concurrency: Safe; no idempotency key.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

resourceId*string

Id of the resource (as list shows it).

Lengthlength <= 64

Response Body

The projected resource.

application/json
  1. response

One resource, projected onto its kind's columns followed by its detail columns.

kind*AssistantResourceKindName

A resource kind of the read-only resource layer (closed set).

Value in"instance""volume""network""sg""fip"
columns*array<string>
data*

One projected resource -- column key to a scalar cell (string, number, boolean or null).

consoleRoute*string
curl -X GET "https://example.com/scopes/string/assistant/resources/network/string"
{  "kind": "instance",  "columns": [    "string"  ],  "data": {},  "consoleRoute": "string"}