Artifacts

APIs to get, list artifacts

Redirect to Harness Artifact Page

Securityx-api-key

Request

path Parameters

registry_identifier required	string Unique registry Identifier in a account.
artifact required	string Name of artifact.

query Parameters

accountIdentifier	string Account Identifier
version	string Version

Responses

302

Temporary Redirect

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_identifier}/artifact/{artifact}/redirect

Request samples

curl
Java
Go

Response samples

application/json

{"code": "404",
"details": { },
"message": "string"
}

Delete Artifact

Delete Artifact.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/har/api/v1/registry/{registry_ref}/artifact/{artifact}

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

Update Artifact Labels

Update Artifact Labels.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.

Request Body schema: application/json

request to update artifact labels

labels

required

Array of strings

Responses

200

response to get artifact label response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

put/har/api/v1/registry/{registry_ref}/artifact/{artifact}/labels

Request samples

Payload
curl
Java
Go

application/json

{"labels": ["string"
]
}

Response samples

application/json

{"data": {"createdAt": "string",
"downloadsCount": 0,
"imageName": "string",
"labels": ["string"
],
"modifiedAt": "string",
"packageType": "DOCKER"
},
"status": "SUCCESS"
}

Get Artifact Stats

Get Artifact Stats.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.

query Parameters

from	string Date. Format - MM/DD/YYYY
to	string Date. Format - MM/DD/YYYY

Responses

200

response to get artifact stats response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/{artifact}/stats

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"downloadCount": 0,
"downloadSize": 0,
"totalStorageSize": 0,
"uploadSize": 0
},
"status": "SUCCESS"
}

Get Artifact Summary

Get Artifact Summary.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.

Responses

200

response to get artifact summary

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/{artifact}/summary

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"createdAt": "string",
"downloadsCount": 0,
"imageName": "string",
"labels": ["string"
],
"modifiedAt": "string",
"packageType": "DOCKER"
},
"status": "SUCCESS"
}

Delete an Artifact Version

Delete Artifact Version.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.
version required	string Name of Artifact Version.

Responses

200

Success Response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}

Request samples

curl
Java
Go

Response samples

application/json

{"status": "SUCCESS"
}

Describe Artifact Deployments

Get Artifact Deployments

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.
version required	string Name of Artifact Version.

query Parameters

env_type	string env type Enum: "PreProduction" "Production"
page	integer <int64> Default: 1 Current page number
size	integer <int64> Default: 20 Number of items per page
sort_order	string sortOrder
sort_field	string sortField
search_term	string search Term.

Responses

200

response to get docker artifact deployments details

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/deploymentdetails

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"deployments": {"deployments": [{"count": 0,
"envIdentifier": "string",
"envName": "string",
"envType": "PreProduction",
"infraIdentifier": "string",
"infraName": "string",
"lastDeployedAt": "string",
"lastDeployedById": "string",
"lastDeployedByName": "string",
"lastPipelineExecutionId": "string",
"lastPipelineExecutionName": "string",
"orgIdentifier": "string",
"pipelineId": "string",
"projectIdentifier": "string",
"serviceIdentifier": "string",
"serviceName": "string"
}
],
"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1
},
"deploymentsStats": {"PreProduction": 0,
"Production": 0
}
},
"status": "SUCCESS"
}

Get Artifact Version Summary

Get Artifact Version Summary.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.
version required	string Name of Artifact Version.

query Parameters

digest

string

Digest.

Responses

200

response to get docker artifact version summary

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/{artifact}/version/{version}/summary

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"imageName": "string",
"isLatestVersion": true,
"packageType": "DOCKER",
"sscaArtifactId": "string",
"sscaArtifactSourceId": "string",
"stoExecutionId": "string",
"stoPipelineId": "string",
"version": "string"
},
"status": "SUCCESS"
}

List Artifact Versions

Lists all the Artifact Versions.

Securityx-api-key

Request

path Parameters

registry_ref required	string Unique registry path.
artifact required	string Name of artifact.

query Parameters

page	integer <int64> Default: 1 Current page number
size	integer <int64> Default: 20 Number of items per page
sort_order	string sortOrder
sort_field	string sortField
search_term	string search Term.

Responses

200

response for list versions of artifact

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/{artifact}/versions

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"artifactVersions": [{"deploymentMetadata": {"nonProdEnvCount": 0,
"prodEnvCount": 0
},
"digestCount": 0,
"downloadsCount": 0,
"islatestVersion": true,
"lastModified": "string",
"name": "string",
"packageType": "DOCKER",
"pullCommand": "string",
"registryIdentifier": "string",
"registryPath": "string",
"size": "string"
}
],
"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1
},
"status": "SUCCESS"
}

List Artifact Labels

List Artifact Labels.

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Unique registry path.

query Parameters

page	integer <int64> Default: 1 Current page number
size	integer <int64> Default: 20 Number of items per page
search_term	string search Term.

Responses

200

response for list artifact labels

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/labels

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"itemCount": 1,
"labels": ["string"
],
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1
},
"status": "SUCCESS"
}

Get Artifact Stats

Get Artifact Stats.

Securityx-api-key

Request

path Parameters

registry_ref

required

string

Unique registry path.

query Parameters

from	string Date. Format - MM/DD/YYYY
to	string Date. Format - MM/DD/YYYY

Responses

200

response to get artifact stats response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/registry/{registry_ref}/artifact/stats

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"downloadCount": 0,
"downloadSize": 0,
"totalStorageSize": 0,
"uploadSize": 0
},
"status": "SUCCESS"
}

Get Artifact Stats

Get Artifact Stats.

Securityx-api-key

Request

path Parameters

space_ref

required

string

Unique space path.

query Parameters

from	string Date. Format - MM/DD/YYYY
to	string Date. Format - MM/DD/YYYY

Responses

200

response to get artifact stats response

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/har/api/v1/spaces/{space_ref}/artifact/stats

Request samples

curl
Java
Go

Response samples

application/json

{"data": {"downloadCount": 0,
"downloadSize": 0,
"totalStorageSize": 0,
"uploadSize": 0
},
"status": "SUCCESS"
}

➔ Next to Docker Artifacts