Update package metadata

Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties.

PATCH/organizations/{organizationName}/environments/{environmentName}/packages/{packageName}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

environmentName*string

The unique identifier of the environment

Match^[a-zA-Z0-9_ -]+$

packageName*string

The unique identifier of the package

Match^[a-zA-Z0-9_ -]+$

Request Body

application/json

Represents a Malloy data model package containing models, queries, and related resources

name?IdentifierPattern

The unique name of the package within its environment

Match^[a-zA-Z0-9_ -]+$

latestVersion?SemanticVersionPattern

The version identifier of the most recent published version

Match^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$

description?string

Human-readable description of the package's purpose and contents

createdAt?string

ISO 8601 timestamp indicating when the package was first created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when the package was last modified

Formatdate-time

replicationCount?integer

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.

Range1 <= value <= 10

resourceIdentifier?ResourceIdentifierPattern

Unique resource identifier for the package, used for API references and permissions

Match^[a-zA-Z0-9_/.:-]+$

indexStatus?IndexStatus

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).

Value in

"unknown"
"indexing"
"indexed"
"failed"
"retry"

autoPromote?boolean

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.

autoArchiveTtl?string

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 Body

`application/json`

curl --request PATCH \  --url 'https://example.com/organizations/string/environments/string/packages/string' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "name": "string",  "latestVersion": "string",  "description": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "replicationCount": 1,  "resourceIdentifier": "string",  "indexStatus": "unknown",  "autoPromote": true,  "autoArchiveTtl": "string"}

Update package metadata

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`