Update package metadata
Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties.
Authorization: Requires package admin or modeler permissions. Validation: Updates are validated against package constraints and naming rules.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the organization Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$The unique identifier of the environment Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$The unique identifier of the package Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$Body
Represents a Malloy data model package containing models, queries, and related resources
The unique name of the package within its environment
^[a-zA-Z0-9_ -]+$The version identifier of the most recent published version
^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$Human-readable description of the package's purpose and contents
ISO 8601 timestamp indicating when the package was first created
ISO 8601 timestamp indicating when the package was last modified
Number of replicas for high availability and performance. When sent on create, this value is stored as-is (within min/max). When omitted on create, Credible manages it for you. When omitted on update, the existing value is left unchanged.
1 <= x <= 10Unique resource identifier for the package, used for API references and permissions
^[a-zA-Z0-9_/.:-]+$Status of the indexing process. Possible values: unknown (initial state, indexing not yet started), indexing (currently being processed), indexed (successfully indexed and ready for use), failed (indexing process encountered an error).
unknown, indexing, indexed, failed, retry Package-scoped auto-promote policy applied as a default to each newly
published version: when true, a new version is armed (see
Version.promoteWhenReady) and the lifecycle reconciler promotes it to
latestVersion once it is ready, subject to the never-been-latest
rollback guard. Newly created packages default this to true: a package
created without an explicit autoPromote gets auto-promote enabled.
Omitting the field on update leaves the policy unchanged; toggling it on
does not retroactively arm existing versions. Independent of
autoArchiveTtl.
Package-scoped ttl auto-archive policy: how long a version is retained
after it stops being latest, e.g. 30d, 24h, 2w (units s, m, h, d,
w). A formerly-latest version is archived (its materialized tables
reclaimed) once it has been demoted for longer than this ttl; the current
latest is never archived. 0 archives a version as soon as it is demoted
(keep-only-latest, modulo the reconciler tick) — note this trades away the
cheap rollback window. A non-empty value enables auto-archive; an empty
string disables it. Newly created packages default to 30d: a package
created without an explicit autoArchiveTtl gets 30-day auto-archive.
Omitting the field on update leaves the policy unchanged. Independent of
autoPromote.
Response
Package updated successfully
Represents a Malloy data model package containing models, queries, and related resources
The unique name of the package within its environment
^[a-zA-Z0-9_ -]+$The version identifier of the most recent published version
^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$Human-readable description of the package's purpose and contents
ISO 8601 timestamp indicating when the package was first created
ISO 8601 timestamp indicating when the package was last modified
Number of replicas for high availability and performance. When sent on create, this value is stored as-is (within min/max). When omitted on create, Credible manages it for you. When omitted on update, the existing value is left unchanged.
1 <= x <= 10Unique resource identifier for the package, used for API references and permissions
^[a-zA-Z0-9_/.:-]+$Status of the indexing process. Possible values: unknown (initial state, indexing not yet started), indexing (currently being processed), indexed (successfully indexed and ready for use), failed (indexing process encountered an error).
unknown, indexing, indexed, failed, retry Package-scoped auto-promote policy applied as a default to each newly
published version: when true, a new version is armed (see
Version.promoteWhenReady) and the lifecycle reconciler promotes it to
latestVersion once it is ready, subject to the never-been-latest
rollback guard. Newly created packages default this to true: a package
created without an explicit autoPromote gets auto-promote enabled.
Omitting the field on update leaves the policy unchanged; toggling it on
does not retroactively arm existing versions. Independent of
autoArchiveTtl.
Package-scoped ttl auto-archive policy: how long a version is retained
after it stops being latest, e.g. 30d, 24h, 2w (units s, m, h, d,
w). A formerly-latest version is archived (its materialized tables
reclaimed) once it has been demoted for longer than this ttl; the current
latest is never archived. 0 archives a version as soon as it is demoted
(keep-only-latest, modulo the reconciler tick) — note this trades away the
cheap rollback window. A non-empty value enables auto-archive; an empty
string disables it. Newly created packages default to 30d: a package
created without an explicit autoArchiveTtl gets 30-day auto-archive.
Omitting the field on update leaves the policy unchanged. Independent of
autoPromote.