DocumentationAPI reference

Rust · 0.1.0

Batch Get Instance Settings

POST /api/v1/instance/settings:batchGet

InstanceService · InstanceService_BatchGetInstanceSettings

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Read policy is per key: STORAGE and NOTIFICATION require instance ADMIN, AI requires authentication, and bootstrap-safe keys may be read anonymously. A batch applies the same checks to every requested name.

Batch limits and access

Provide at most 100 full instance/settings/{KEY} names. The server evaluates the same per-key policy as GetInstanceSetting. An unauthorized or invalid key causes the request to fail rather than becoming an empty per-item result.

Request

Batch gets instance settings.

POST/api/v1/instance/settings:batchGet

Parameters

No path or query parameters are declared.

Request body

Required

application/json · BatchGetInstanceSettingsRequest

Responses

200 · OK

application/json · BatchGetInstanceSettingsResponse

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "InstanceService"
  ],
  "description": "Batch gets instance settings.",
  "operationId": "InstanceService_BatchGetInstanceSettings",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/BatchGetInstanceSettingsRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/BatchGetInstanceSettingsResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}