Skip to main content
PATCH
/
organizations
/
{organizationName}
/
projects
/
{projectName}
/
packages
/
{packageName}
/
versions
/
{versionId}
Update version status
curl --request PATCH \
  --url https://{organization}.admin.credibledata.com/api/v0/organizations/{organizationName}/projects/{projectName}/packages/{packageName}/versions/{versionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archiveStatus": "archive",
  "indexStatus": "unknown"
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archiveStatus": "archive",
  "indexStatus": "unknown"
}

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_-]+$
​
projectName
string
required

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

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

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

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

The unique identifier of the version Version identifier pattern supporting dots and dashes

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

Body

application/json

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

​
id
string

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

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
​
createdAt
string<date-time>

ISO 8601 timestamp indicating when this version was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when this version was last modified

​
archiveStatus
enum<string>

Current status of the package version, controlling its availability

Available options:
archive,
unarchive,
error_state
​
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

Response

Version updated successfully

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

​
id
string

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

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
​
createdAt
string<date-time>

ISO 8601 timestamp indicating when this version was created

​
updatedAt
string<date-time>

ISO 8601 timestamp indicating when this version was last modified

​
archiveStatus
enum<string>

Current status of the package version, controlling its availability

Available options:
archive,
unarchive,
error_state
​
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