> ## 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. # List > List releases. This API version has reached end of life. See [supported versions](/developers/platform-api/versioning#supported-versions). | Scope | Required | | --------------- | -------- | | `releases:read` | Yes | ## OpenAPI ````yaml /references/platform-api/2025-10-21.yaml get /releases openapi: 3.0.3 info: title: Miru API version: 2025-10-21.zion license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.mirurobotics.com/beta description: Miru API security: - ApiKeyAuth: [] paths: /releases: get: tags: - Releases summary: List description: List releases. operationId: listReleases parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/releases_components-parameters-order_by' - $ref: '#/components/parameters/releases_components-parameters-expand_list' - $ref: '#/components/parameters/releases_components-parameters-id' - $ref: '#/components/parameters/version' responses: '200': description: Successfully listed the releases. content: application/json: schema: $ref: '#/components/schemas/ReleaseList' x-codeSamples: - lang: Python source: |- from miru_server_sdk import Miru client = Miru( api_key="My API Key", ) releases = client.releases.list() print(releases) components: parameters: offset: name: offset in: query required: false description: >- The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20. schema: type: integer default: 0 minimum: 0 limit: name: limit in: query required: false description: >- The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15. schema: type: integer default: 10 minimum: 1 maximum: 100 releases_components-parameters-order_by: name: order_by in: query required: false schema: $ref: '#/components/schemas/ReleaseOrderBy' description: The order to sort the releases. releases_components-parameters-expand_list: name: expand[] in: query required: false schema: type: array items: $ref: '#/components/schemas/ExpandReleaseList' description: The fields to expand in the releases list. releases_components-parameters-id: name: id in: query required: false description: The release ID to filter by. schema: type: string example: rls_123 version: name: version in: query required: false description: The release version to filter by. schema: type: string example: v1.0.0 schemas: ReleaseList: title: Release List allOf: - $ref: '#/components/schemas/PaginatedList' - type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/Release' ReleaseOrderBy: type: string enum: - id:asc - id:desc - created_at:desc - created_at:asc x-enum-varnames: - RELEASE_ORDER_BY_ID_ASC - RELEASE_ORDER_BY_ID_DESC - RELEASE_ORDER_BY_CREATED_AT_DESC - RELEASE_ORDER_BY_CREATED_AT_ASC default: created_at:desc ExpandReleaseList: type: string enum: - total_count - config_schemas x-enum-varnames: - RELEASE_LIST_EXPAND_WITH_TOTAL_COUNT - RELEASE_LIST_EXPAND_CONFIG_SCHEMAS PaginatedList: title: Paginated List type: object required: - object - total_count - limit - offset - has_more properties: object: type: string enum: - list example: list total_count: type: integer format: int64 description: >- The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand[]=total_count) to get the total number of items in the list. limit: type: integer description: >- The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15. default: 10 minimum: 1 maximum: 100 offset: type: integer description: >- The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20. default: 0 minimum: 0 has_more: type: boolean description: >- True if there are more items in the list to return. False if there are no more items to return. example: false Release: title: Release allOf: - $ref: '#/components/schemas/BaseRelease' - type: object required: - config_schemas properties: config_schemas: type: array items: $ref: '#/components/schemas/ConfigSchema' nullable: true description: >- Expand the config schemas using 'expand[]=config_schemas' in the query string. example: [] BaseRelease: title: Base Release type: object required: - object - id - version - created_at - updated_at properties: object: type: string enum: - release example: release id: type: string example: rls_123 description: ID of the release. version: type: string example: v1.0.0 description: The version of the release. created_at: type: string format: date-time example: '2024-01-01T00:00:00Z' description: Timestamp of when the release was created. updated_at: type: string format: date-time example: '2024-01-01T00:00:00Z' description: Timestamp of when the release was last updated. ConfigSchema: title: Config Schema allOf: - $ref: '#/components/schemas/BaseConfigSchema' - type: object required: - config_type properties: config_type: allOf: - $ref: '#/components/schemas/ConfigType' nullable: true description: >- Expand the config type using 'expand[]=config_type' in the query string. example: null BaseConfigSchema: title: Base Config Schema type: object required: - object - id - version - digest - relative_filepath - created_at - updated_at - config_type_id - content properties: object: type: string enum: - config_schema example: config_schema id: type: string example: cfg_sch_123 description: ID of the config schema. version: type: integer example: 2 description: Config schema version for the config type. digest: type: string example: '1234567890' description: Hash of the config schema contents. relative_filepath: type: string example: /v1/motion-control.json description: >- The file path to deploy the config instance relative to `/srv/miru/config_instances`. `v1/motion-control.json` would deploy to `/srv/miru/config_instances/v1/motion-control.json`. 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. content: type: object description: The config schema's JSON Schema definition. example: title: Robot Features type: object properties: enable_autonomy: type: boolean default: true enable_remote_control: type: boolean default: true max_payload_kg: type: number minimum: 0 maximum: 99 default: 10 preferred_speed_mode: type: string enum: - slow - normal - fast default: normal emergency_stop_sensitivity: type: number minimum: 0 maximum: 1 default: 0.8 telemetry: type: object properties: upload_interval_sec: type: integer minimum: 10 maximum: 600 default: 60 heartbeat_interval_sec: type: integer minimum: 1 maximum: 60 default: 10 required: - upload_interval_sec - heartbeat_interval_sec required: - enable_autonomy - enable_remote_control - max_payload_kg - preferred_speed_mode - emergency_stop_sensitivity - telemetry nullable: true ConfigType: title: Config Type allOf: - $ref: '#/components/schemas/BaseConfigType' 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 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. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- The API key to use for authentication. Retrieve your API key from the [Miru dashboard](https://app.mirurobotics.com/settings/api-keys). ````