Skip to main content
GET
List packages in environment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$
environmentName
string
required

The unique identifier of the environment Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$

Query Parameters

limit
integer
default:-1

Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.

Required range: -1 <= x <= 500
offset
integer
default:0

Number of items to skip before starting to return results

Required range: x >= 0

Response

List of packages retrieved successfully

name
string

The unique name of the package within its environment

Pattern: ^[a-zA-Z0-9_ -]+$
latestVersion
string

The version identifier of the most recent published version

Pattern: ^[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<date-time>

ISO 8601 timestamp indicating when the package was first created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the package was last modified

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.

Required range: 1 <= x <= 10
resourceIdentifier
string

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

Pattern: ^[a-zA-Z0-9_/.:-]+$
indexStatus
enum<string>

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

Available options:
unknown,
indexing,
indexed,
failed,
retry
autoPromote
boolean | null

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 | null

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.