List platform-managed model route pools
Generated from the checked-in source. Do not edit this reference by hand.
GET /api/v1/pools
Installation credential or explicit platform-administrator grant required. Lists enabled and disabled shared and personal pools with their current configuration. Ordered by alias using database ordering. after is the exclusive alias cursor returned as next_after; it need not identify a currently existing pool. This is a live view, not a cross-page snapshot: new aliases before the cursor require a fresh traversal. No upstream requests, credentials, endpoints or prices are returned. Pool organization identifiers are API references, not display labels. Without alias this is the paginated collection. For compatibility, ?alias= returns the original single-pool envelope; alias cannot be combined with paging parameters. New member reads use /pools/{reference}. The /pools/index route retains its existing collection contract.
Operation: listPools.
Authentication
Section titled “Authentication”Use the credential and permission scope described above. Each object below is an alternative; schemes within one object are required together.
[ { "bearerAuth": [] }]HTTP request
Section titled “HTTP request”Set NIU_ORIGIN to your installation origin (without /v1). Replace path, query and header placeholders with the required values. Query examples use curl 7.87 or newer to encode values with --url-query. Use the credential scope described above; a bearer token must have the authority required by this operation.
curl --fail-with-body -X GET "$NIU_ORIGIN/api/v1/pools" \ -H "Authorization: Bearer $NIU_BEARER_TOKEN"Parameters
Section titled “Parameters”Location: query. Optional.
{ "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[!-~]+$"}Location: query. Optional.
{ "type": "integer", "minimum": 1, "maximum": 100, "default": 50}Location: query. Optional.
{ "type": "string", "minLength": 1, "maxLength": 200}Request body
Section titled “Request body”No request body is declared.
Responses
Section titled “Responses”HTTP 200
Section titled “HTTP 200”Bounded current configurations and continuation cursor.
Content type: application/json.
{ "oneOf": [ { "type": "object", "required": [ "data", "has_more", "next_after" ], "additionalProperties": false, "properties": { "data": { "type": "array", "maxItems": 100, "items": { "type": "object", "required": [ "alias", "organization_id", "enabled", "revision", "candidates" ], "properties": { "alias": { "type": "string" }, "organization_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "display_name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "public_catalog": { "type": "boolean" }, "billing_mode": { "type": "string", "enum": [ "pool_tariff", "candidate_tariff" ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "candidates": { "type": "array", "minItems": 1, "maxItems": 64, "items": { "type": "object", "required": [ "alias", "priority", "weight", "enabled" ], "properties": { "alias": { "type": "string" }, "priority": { "type": "integer", "minimum": -1000, "maximum": 1000 }, "weight": { "type": "integer", "minimum": 1, "maximum": 10000 }, "enabled": { "type": "boolean" } } } }, "rules": { "type": "array", "maxItems": 32, "items": { "type": "object" } }, "default_action": { "type": "string", "enum": [ "candidates", "reject" ] } } } }, "has_more": { "type": "boolean" }, "next_after": { "type": [ "string", "null" ] } } }, { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "alias", "organization_id", "enabled", "revision", "candidates" ], "properties": { "alias": { "type": "string" }, "organization_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "display_name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "public_catalog": { "type": "boolean" }, "billing_mode": { "type": "string", "enum": [ "pool_tariff", "candidate_tariff" ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "candidates": { "type": "array", "minItems": 1, "maxItems": 64, "items": { "type": "object", "required": [ "alias", "priority", "weight", "enabled" ], "properties": { "alias": { "type": "string" }, "priority": { "type": "integer", "minimum": -1000, "maximum": 1000 }, "weight": { "type": "integer", "minimum": 1, "maximum": 10000 }, "enabled": { "type": "boolean" } } } }, "rules": { "type": "array", "maxItems": 32, "items": { "type": "object" } }, "default_action": { "type": "string", "enum": [ "candidates", "reject" ] } } } } } ]}HTTP 400
Section titled “HTTP 400”Invalid query, alias cursor or page size; framework query errors may use plain text.
HTTP 401
Section titled “HTTP 401”Authentication required.
HTTP 403
Section titled “HTTP 403”Platform administration required.
Behavior and supported scope
Section titled “Behavior and supported scope”Installation credential or explicit platform-administrator grant required. Lists enabled and disabled shared and personal pools with their current configuration. Ordered by alias using database ordering. after is the exclusive alias cursor returned as next_after; it need not identify a currently existing pool. This is a live view, not a cross-page snapshot: new aliases before the cursor require a fresh traversal. No upstream requests, credentials, endpoints or prices are returned. Pool organization identifiers are API references, not display labels. Without alias this is the paginated collection. For compatibility, ?alias= returns the original single-pool envelope; alias cannot be combined with paging parameters. New member reads use /pools/{reference}. The /pools/index route retains its existing collection contract.
Supported scope: implemented