Sign in
Config Schemas

Get

Retrieve a config schema by ID.

get/config_schemas/{config_schema_id}

Path parameters

config_schema_idstring required
Example:cfg_sch_123

The unique identifier of the config schema.

Query parameters

expandConfigSchemaExpansion[]

Fields to expand on the config schema resource.

[
  "documents"
]

Response

Successfully retrieved the config schema.

object'config_schema' required

The object type, which is always config_schema.

idstring required

ID of the config schema.

digeststring required

The digest of the config schema.

config_type_namestring required

The name of the config type.

instance_filepathstring required

The absolute file system path where config instances for this schema are written.

created_atstring date-time required

Timestamp of when the config schema was created.

updated_atstring date-time required

Timestamp of when the config schema was last updated.

config_type_idstring required

ID of the config type.

language'jsonschema' | 'cue' required
format'json' | 'yaml' | 'cue' required

Example response

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "config_type_name": "Motion Control",
  "instance_filepath": "/srv/miru/configs/v1/motion-control.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"
}

Changes

Changed in 2 of the 6 revisions of this API.4

  • 365853b9c33d2See the full diff
    • ○

      added to the / response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed from the / response property allOf list for the response status

      response-property-all-of-removed

  • 7f0f7fc868da2See the full diff
    • ○

      added to the / response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed from the / response property allOf list for the response status

      response-property-all-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog