> ## Documentation Index > Fetch the complete documentation index at: https://docs.internal.nscale.com/llms.txt > Use this file to discover all available pages before exploring further. # Update topology group > List, retrieve, create, and update topology groups. ## OpenAPI ````yaml /openapi/fleet-manager-openapi.yaml patch /api/v1/topology-groups/{id}/ openapi: 3.0.3 info: title: Fleet Manager API version: 1.0.0 description: API for the Nscale Fleet Manager servers: [] security: [] paths: /api/v1/topology-groups/{id}/: patch: tags: - Topology Groups summary: Update topology group description: List, retrieve, create, and update topology groups. operationId: api_v1_topology_groups_partial_update parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this topology group. required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTopologyGroupWrite' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTopologyGroupWrite' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTopologyGroupWrite' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TopologyGroupRead' description: '' '400': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Authentication credentials were not provided or are invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: You do not have permission to perform this action. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - oauth2: - topology-group:update - cookieAuth: [] components: schemas: PatchedTopologyGroupWrite: type: object description: Write serializer for TopologyGroup create and update operations. properties: parent: type: string format: uuid nullable: true facet: $ref: '#/components/schemas/FacetEnum' label: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: $ref: '#/components/schemas/TopologyGroupTypeEnum' site: type: string format: uuid device_ids: type: array items: type: string format: uuid writeOnly: true description: List of device UUIDs to include in the group. maxItems: 1000 annotations: type: object additionalProperties: type: string description: >- Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready'). tags: type: array items: type: string description: >- Tags for the resource. Must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated and sorted. TopologyGroupRead: type: object description: Read serializer for TopologyGroup responses. properties: id: type: string format: uuid readOnly: true parent: type: string format: uuid nullable: true facet: $ref: '#/components/schemas/FacetEnum' label: type: string maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: $ref: '#/components/schemas/TopologyGroupTypeEnum' site: type: string format: uuid site_name: type: string readOnly: true parent_label: type: string nullable: true readOnly: true devices: type: array items: type: string format: uuid readOnly: true device_count: type: integer readOnly: true children: type: array items: type: string format: uuid readOnly: true path_labels: type: array items: type: string readOnly: true annotations: type: object additionalProperties: type: string description: >- Key-value annotations. Keys must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'org-id', 'gpu_ready'). tags: type: array items: type: string description: >- Tags for the resource. Must start with a lowercase letter and contain only lowercase alphanumeric segments joined by hyphens or underscores (e.g. 'gpu-ready', 'needs_review'). Stored deduplicated and sorted. links: allOf: - $ref: '#/components/schemas/TopologyGroupLinks' readOnly: true created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - children - created_at - device_count - devices - facet - id - label - links - parent_label - path_labels - site - site_name - type - updated_at ErrorResponse: type: object description: >- Uniform error body for every 4xx/5xx response. `detail` is a human-readable message, always present, safe to display to end users. `code` is the machine-readable identifier. `field_errors` lists per-input-field validation messages and is empty for non-field errors (auth, permission, not-found, conflict, server). required: - detail - code - field_errors properties: detail: type: string code: $ref: '#/components/schemas/ErrorCodeEnum' field_errors: type: array items: $ref: '#/components/schemas/FieldError' FacetEnum: enum: - networking - power type: string description: |- * `networking` - networking * `power` - power TopologyGroupTypeEnum: enum: - root - super-spine - spine - pod - nvlink-domain - unknown type: string description: >- * `root` - root * `super-spine` - super-spine groups multiple spines together * `spine` - spine groups multiple pods together * `pod` - pod groups either multiple devices or multiple nvlink-domains together * `nvlink-domain` - nvlink-domain groups multiple devices together (min: 1) * `unknown` - unknown TopologyGroupLinks: type: object description: Serializer for topology group links. properties: self: type: string format: uri readOnly: true collection: type: string format: uri readOnly: true site: type: string format: uri readOnly: true devices: type: string format: uri readOnly: true required: - collection - devices - self - site ErrorCodeEnum: type: string description: >- Stable machine-readable error identifier. New members may be added within this API version; clients must tolerate unknown values. enum: - error - invalid - parse_error - authentication_failed - not_authenticated - permission_denied - not_found - method_not_allowed - not_acceptable - unsupported_media_type - conflict - enrollment_infrastructure_reference_pending - enrollment_infrastructure_reference_changed - unprocessable_entity - throttled - service_unavailable FieldError: type: object description: One input field's validation messages. required: - field - messages properties: field: type: string description: >- Dotted path to the offending input field, or to the collection row when the whole row is invalid (e.g. `filters.end_date`, `memberships.0.role`, `memberships.0`). messages: type: array minItems: 1 items: type: string securitySchemes: oauth2: type: oauth2 flows: {} cookieAuth: type: apiKey in: cookie name: sessionid ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.