> ## Documentation Index > Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt > Use this file to discover all available pages before exploring further. # Get > Retrieve a config instance by ID. | Scope | Required | | - | - | | `config_instances:read` | Yes | ## OpenAPI ````yaml /references/platform-api/2026-10-28.yaml get /config_instances/{config_instance_id} openapi: 3.0.3 info: title: Miru Platform API description: The API between Miru and any external client version: 2026-10-28.everglades license: name: MIT url: https://opensource.org/licenses/MIT x-release-version: 2026-10-28.everglades x-git-commit: sha: da19e118a12d7f7069f89d7781c0085522789785 url: >- https://github.com/mirurobotics/openapi/commit/da19e118a12d7f7069f89d7781c0085522789785 message: >- chore(stlc): seal custom-code tracking files (#381) Automated by the stlc generate workflow: a push-to-main or manual `workflow_dispatch` publish re-sealed custom code, updating the tracking files under `sdkgen/*/stainless/custom-code/`. Publishing targets the private staging repos. Safe to merge - this PR's head branch `stlc/seal-tracking` is skipped by the generate workflow's skip-bot guard in `detect`, and on merge the push loop-breaker `guard` sees only custom-code changes and runs no rebuild. --- View with [code]smith Autofix with [code]smith Need help on this PR? Tag @codesmith with what you need. Co-authored-by: stlc-sealback-bot[bot] <298483487+stlc-sealback-bot[bot]@users.noreply.github.com> Co-authored-by: Ben author: stlc-sealback-bot[bot] branch: HEAD dirty: false x-build: built_at: '2026-10-28T22:21:18.805528+00:00' servers: - url: https://api.mirurobotics.com/beta description: Miru Platform API security: - ApiKeyAuth: [] paths: /config_instances/{config_instance_id}: parameters: - $ref: '#/components/parameters/MiruVersion' get: tags: - Config Instances summary: Get description: Retrieve a config instance by ID. operationId: getConfigInstance parameters: - $ref: '#/components/parameters/config_instance_id' - $ref: '#/components/parameters/config_instance_expansions' responses: '200': description: Successfully retrieved the config instance. content: application/json: schema: $ref: '#/components/schemas/ConfigInstance' components: parameters: MiruVersion: name: Miru-Version in: header required: true schema: type: string example: 2026-10-28.everglades description: The API version the client was built against. config_instance_id: name: config_instance_id in: path required: true description: The unique identifier of the config instance. schema: type: string example: cfg_inst_123 config_instance_expansions: name: expand in: query required: false description: Fields to expand on the config instance resource. schema: type: array items: $ref: '#/components/schemas/ConfigInstanceExpansion' example: - content schemas: ConfigInstance: title: Config Instance allOf: - $ref: '#/components/schemas/BaseConfigInstance' - type: object properties: config_schema: allOf: - $ref: '#/components/schemas/ConfigSchema' description: >- Expand the config schema using 'expand=config_schema' in the query string. config_type: allOf: - $ref: '#/components/schemas/ConfigType' description: >- Expand the config type using 'expand=config_type' in the query string. content: allOf: - $ref: '#/components/schemas/InstanceContent' description: >- The configuration values associated with the config instance. Expand the content using 'expand=content' in the query string. example: object: config_instance id: cfg_inst_123 config_type_name: Motion Control filepath: /srv/miru/configs/v1/motion-control.json slot_key: default created_at: '2021-01-01T00:00:00Z' config_schema_id: cfg_sch_123 config_type_id: cfg_typ_123 ConfigInstanceExpansion: type: string enum: - content - config_schema - config_type x-enum-varnames: - CONFIG_INSTANCE_EXPAND_CONTENT - CONFIG_INSTANCE_EXPAND_CONFIG_SCHEMA - CONFIG_INSTANCE_EXPAND_CONFIG_TYPE BaseConfigInstance: title: Base Config Instance type: object required: - object - id - config_type_name - filepath - created_at - config_schema_id - config_type_id - slot_key properties: object: type: string enum: - config_instance example: config_instance x-stainless-const: true description: The object type, which is always `config_instance`. id: type: string example: cfg_inst_123 description: ID of the config instance. config_type_name: type: string example: Motion Control description: The name of the config type. filepath: type: string example: /srv/miru/configs/v1/motion-control.json description: The absolute file system path where this config instance is written. slot_key: type: string example: controller_2 description: >- The key of the config schema slot this instance is bound to. Must match the `key` of one of the slots declared by this instance's config schema. created_at: type: string format: date-time example: '2021-01-01T00:00:00Z' description: The timestamp of when the config instance was created. config_schema_id: type: string example: cfg_sch_123 description: ID of the config schema which the config instance must adhere to. config_type_id: type: string example: cfg_type_123 description: >- ID of the config type which the config instance (and its schema) is a part of. ConfigSchema: title: Config Schema allOf: - $ref: '#/components/schemas/BaseConfigSchema' - type: object properties: config_type: allOf: - $ref: '#/components/schemas/ConfigType' description: >- Expand the config type using 'expand=config_type' in the query string. example: object: config_schema id: cfg_sch_123 digest: sha256:1234567890 os: linux config_type_name: Motion Control instance_slots: - key: default name: Default filepath: /srv/miru/configs/v1/motion-control.json required: true instance_format: json created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' config_type_id: cfg_typ_123 language: jsonschema format: json ConfigType: allOf: - $ref: '#/components/schemas/BaseConfigType' example: object: config_type id: cfg_typ_123 name: Motion Control slug: motion-control created_at: '2021-01-01T00:00:00Z' updated_at: '2021-01-01T00:00:00Z' created_by_id: usr_123 updated_by_id: usr_123 InstanceContent: title: Instance Content type: object required: - format - data properties: format: $ref: '#/components/schemas/InstanceFormat' data: type: string description: The content's values, serialized in `format`. example: | { "enable_autonomy": true, "enable_remote_control": true, "max_payload_kg": 10.0 } example: format: json data: | { "enable_autonomy": true, "enable_remote_control": true, "max_payload_kg": 10.0 } BaseConfigSchema: title: Base Config Schema type: object required: - object - id - digest - os - config_type_name - instance_format - created_at - updated_at - config_type_id - language - format - instance_slots properties: object: type: string enum: - config_schema example: config_schema x-stainless-const: true description: The object type, which is always `config_schema`. id: type: string example: cfg_sch_123 description: ID of the config schema. digest: type: string example: sha256:1234567890 description: The digest of the config schema. os: allOf: - $ref: '#/components/schemas/OS' readOnly: true description: >- The operating system family this config schema targets, derived from its instance slot filepaths, which must all agree. A schema created without `instance_slots` gets a default slot at a Unix path, so it is `linux`. Read-only: clients cannot set it. config_type_name: type: string example: Motion Control description: The name of the config type. instance_slots: type: array minItems: 1 description: >- The file system destinations this config schema writes to. Every config schema has at least one slot. Slots share the schema's validation and differ only in where the file is written; a file needing different validation is a different config type, not a slot. Slot keys and filepaths must each be unique within the schema, and slot filepaths must be unique across every config schema in a release. items: $ref: '#/components/schemas/InstanceSlot' example: - key: default name: Default filepath: /srv/miru/configs/v1/motion-control.json required: true instance_format: $ref: '#/components/schemas/InstanceFormat' created_at: type: string format: date-time example: '2021-01-01T00:00:00Z' description: Timestamp of when the config schema was created. updated_at: type: string format: date-time example: '2021-01-01T00:00:00Z' description: Timestamp of when the config schema was last updated. config_type_id: type: string example: cfg_typ_123 description: ID of the config type. language: $ref: '#/components/schemas/SchemaLanguage' format: $ref: '#/components/schemas/SchemaFormat' documents: allOf: - $ref: '#/components/schemas/SchemaDocuments' description: >- Expand the config schema documents using `expand=documents` in the query string. example: - id: doc_123 name: main.json data: | { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object" } BaseConfigType: title: Config Type type: object required: - object - id - name - slug - created_at - updated_at properties: object: type: string enum: - config_type example: config_type x-stainless-const: true description: The object type, which is always `config_type`. id: type: string example: cfg_123 description: ID of the config type. name: type: string example: My Config Type description: Name of the config type. slug: type: string example: my-config-type description: An immutable, code-friendly name for the config type. created_at: type: string format: date-time example: '2021-01-01T00:00:00Z' description: Timestamp of when the config type was created. updated_at: type: string format: date-time example: '2021-01-01T00:00:00Z' description: Timestamp of when the config type was last updated. InstanceFormat: title: Instance Format type: string description: > The serialization format of config content. A config instance is written to the device filesystem in this format. - `json`: standard JSON. - `yaml`: YAML 1.2. - `jsonc`: JSON with comments (JSON plus `//` and `/* */` comment syntax). - `xml`: XML. - `csv`: comma-separated values (RFC 4180). - `text`: plain, unstructured text with no specific format. enum: - json - yaml - jsonc - xml - csv - text x-enum-varnames: - INSTANCE_FORMAT_JSON - INSTANCE_FORMAT_YAML - INSTANCE_FORMAT_JSONC - INSTANCE_FORMAT_XML - INSTANCE_FORMAT_CSV - INSTANCE_FORMAT_TEXT OS: title: OS type: string description: > An operating system family, from the agent's build-time OS vocabulary. Shared across resources (devices, config schemas, file rules, releases). This is the machine-readable OS kind, distinct from a human-readable version string. - `linux` - `windows` example: linux enum: - linux - windows x-enum-varnames: - OS_LINUX - OS_WINDOWS InstanceSlot: title: Instance Slot type: object required: - key - name - filepath - required properties: key: type: string pattern: ^[a-z0-9][a-z0-9_-]*$ maxLength: 128 example: controller_2 description: >- An immutable, code-friendly identifier for this slot, unique within the schema. Lowercase alphanumerics, underscores, and hyphens; must start with an alphanumeric; at most 128 characters. name: type: string example: Controller 2 description: The human-readable name of this slot. filepath: type: string example: >- /var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml description: >- The absolute file system path where instances bound to this slot are written. Must be unique within the schema, and unique across every config schema in a release. required: type: boolean example: true description: >- Whether every deployment of a release containing this schema must include an instance for this slot. A deployment includes at most one config instance per slot. description: type: string example: Topic list for the second motor controller. description: An optional human-readable description of this slot. example: key: controller_2 name: Controller 2 filepath: >- /var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml required: true description: Topic list for the second motor controller. SchemaLanguage: title: Schema Language type: string example: jsonschema enum: - jsonschema - cue - opaque x-enum-varnames: - JSONSCHEMA - CUE - OPAQUE SchemaFormat: title: Schema Format type: string enum: - json - yaml - cue x-enum-varnames: - SCHEMA_FORMAT_JSON - SCHEMA_FORMAT_YAML - SCHEMA_FORMAT_CUE SchemaDocuments: type: array items: $ref: '#/components/schemas/SchemaDocument' example: - id: doc_123 name: main.json data: | { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object" } SchemaDocument: title: Schema Document type: object required: - id - name - data properties: id: type: string description: The unique identifier for this document. example: doc_123 name: type: string description: The document filename. example: main.json data: type: string description: The raw document content. example: id: doc_123 name: main.json data: | { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object" } securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: The API key to use for authentication. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.