Update version status

Updates the status of a specific package version, typically used for archiving or unarchiving versions to control their availability.

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

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_ -]+$

versionId*string

The unique identifier of the version

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

Request Body

application/json

Represents a specific version of a package with metadata and lifecycle information

id?SemanticVersionPattern

The unique version identifier, typically following semantic versioning (e.g., 1.2.3)

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

createdAt?string

ISO 8601 timestamp indicating when this version was created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when this version was last modified

Formatdate-time

archiveStatus?string

Current status of the package version, controlling its availability

Value in

"archive"
"unarchive"
"error_state"

metadata?

Metadata from indexing failures, attached to a package version

indexingProgress?

Aggregate package-indexing (source-extraction) progress for a package version, polled from the entity-indexing service while the version is being indexed. Populated on the single-version read while indexing is in progress (indexStatus = indexing); null once indexed/failed or when progress is unavailable. Mirrors ConnectionIndexingProgress. Per-dimension index progress is surfaced separately via the index-run / dimensional-index APIs, not here.

buildPlan?

The persist build plan's dependency graph (DAG) for this version — the persist sources and their dependsOn edges. Read from the publisher's deterministic build plan. Populated only on the single-version GET (getVersion); null on list responses and when the version declares no persist source or no healthy worker can serve the plan.

Response Body

`application/json`

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

{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "archiveStatus": "archive",  "stale": true,  "staleSince": "2019-08-24T14:15:22Z",  "staleReasons": [    "FRESHNESS_WINDOW_EXCEEDED"  ],  "promoteWhenReady": true,  "promotedAt": "2019-08-24T14:15:22Z",  "demotedAt": "2019-08-24T14:15:22Z",  "metadata": {    "displayErrorMessage": "string",    "rawErrorMessage": "string"  },  "indexingProgress": {    "packageProgress": {      "sourcesTotal": 0,      "sourcesProcessing": 0,      "sourcesCompleted": 0,      "sourcesFailed": 0,      "entitiesFound": 0    }  },  "buildStatus": "BUILDING",  "scope": "version",  "materializationSchedule": "string",  "nextScheduledAt": "2019-08-24T14:15:22Z",  "lastRefreshedAt": "2019-08-24T14:15:22Z",  "materializationFreshnessWindowSeconds": 0,  "materializationFreshnessFallback": "string",  "buildPlan": {    "nodes": [      {        "sourceId": "string",        "name": "string",        "connectionName": "string",        "modelPath": "string"      }    ],    "edges": [      {        "from": "string",        "to": "string"      }    ]  }}

Update version status

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`