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.

List security groups through the read-only resource layer

GET
/scopes/{scopeId}/assistant/resources/sg

read-only resource layer (Cloud Shell sg list). Reads one page of the scope's security groups back through the edge with the CALLER's own credential from the existing list route, so that route's authorization and row-level security decide what is returned, and projects each row onto the sg columns of resource-kinds (scalar cells; an embedded object shows its name). The layer has no access of its own: an upstream 401/403/404 is relayed verbatim. Validation: READ on network for the scope -> 403 otherwise; unreachable scope -> 404; page >= 1 and 1 <= pageSize <= 50 -> 422. Feature flag: 404 while the assistant service is disabled. Async & state: Synchronous read; no state change. GET only -- the layer has no write route. Errors: 401; 403; 404; 422; 429 (edge rate limit, also consumed by the read-back); 500; 503 when the read-back cannot reach the upstream route. 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.

Query Parameters

page?integer

1-based page number.

Range1 <= value
Default1
pageSize?integer

Rows per page (max 50).

Range1 <= value <= 50
Default50

Response Body

One page of projected rows.

application/json
  1. response

One page of a kind, projected onto its columns. List responses keep the { data, meta } shape.

kind*AssistantResourceKindName

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

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

Pagination envelope metadata. List responses are always { data, meta } — never a naked array.

consoleRoute*string
curl -X GET "https://example.com/scopes/string/assistant/resources/sg"
{  "kind": "instance",  "columns": [    "string"  ],  "data": [    {}  ],  "meta": {    "page": 1,    "pageSize": 1,    "total": 0,    "hasNext": true  },  "consoleRoute": "string"}