Artifact versions

List Artifact Versions

get

Get artifact versions according to query filters.

Args: artifact_version_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: The authentication context.

Returns: The artifact versions according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
run_metadataany ofOptional
string[]Optional
or
nullOptional
tagany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
artifactany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
artifact_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
versionany ofOptional
stringOptional
or
nullOptional
version_numberany ofOptional
integerOptional
or
stringOptional
or
nullOptional
uriany ofOptional
stringOptional
or
nullOptional
materializerany ofOptional
stringOptional
or
nullOptional
typeany ofOptional
stringOptional
or
nullOptional
data_typeany ofOptional
stringOptional
or
nullOptional
artifact_store_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
only_unusedany ofOptionalDefault: false
booleanOptional
or
nullOptional
has_custom_nameany ofOptional
booleanOptional
or
nullOptional
modelany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
pipeline_runany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/artifact_versions

Create Artifact Version

post

Create a new artifact version.

Args: artifact_version: The artifact version to create.

Returns: The created artifact version.

Authorizations
OAuth2passwordRequired
Token URL:
Body

Request model for artifact versions.

userany ofOptional
string · uuidOptional
or
nullOptional
projectstring · uuidRequired
artifact_idany ofOptional
string · uuidOptional
or
nullOptional
artifact_nameany ofOptional
stringOptional
or
nullOptional
versionany ofOptional
integerOptional
or
stringOptional
or
nullOptional
has_custom_namebooleanOptionalDefault: false
typestring · enumRequired

All possible types an artifact can have.

Possible values:
artifact_store_idany ofOptional
string · uuidOptional
or
nullOptional
uristring · max: 65535Required
content_hashany ofOptional
string · max: 255Optional
or
nullOptional
tagsany ofOptional

Should be a list of plain strings, e.g., ['tag1', 'tag2']

string[]Optional
or
nullOptional
visualizationsany ofOptional
or
nullOptional
save_typestring · enumRequired

All possible method types of how artifact versions can be saved.

Possible values:
metadataany ofOptional
or
nullOptional
item_countany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/api/v1/artifact_versions

Prune Artifact Versions

delete

Prunes unused artifact versions and their artifacts.

Args: project_name_or_id: The project name or ID to prune artifact versions for. only_versions: Only delete artifact versions, keeping artifacts

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofRequired
stringOptional
or
string · uuidOptional
only_versionsbooleanOptionalDefault: true
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/api/v1/artifact_versions

No content

Get Artifact Version

get

Get an artifact version by ID.

Args: artifact_version_id: The ID of the artifact version to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The artifact version with the given ID.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
chevron-right
200

Successful Response

application/json
get
/api/v1/artifact_versions/{artifact_version_id}

Update Artifact Version

put

Update an artifact by ID.

Args: artifact_version_id: The ID of the artifact version to update. artifact_version_update: The update to apply to the artifact version.

Returns: The updated artifact.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Body

Artifact version update model.

nameany ofOptional
stringOptional
or
nullOptional
add_tagsany ofOptional
string[]Optional
or
nullOptional
remove_tagsany ofOptional
string[]Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
put
/api/v1/artifact_versions/{artifact_version_id}

Delete Artifact Version

delete

Delete an artifact version by ID.

Args: artifact_version_id: The ID of the artifact version to delete.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/api/v1/artifact_versions/{artifact_version_id}

No content

Last updated

Was this helpful?