Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Artifacts

Files and documents attached to policies and policy blocks.

Returns all artifacts.

get

Returns all artifacts.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
idstringOptional

Artifact identifier

Example: 69aeb71ef8c5b278e3bab4e5
typestring · enumOptional

Tool|Policy

Possible values:
policyIdstringOptional

Policy identifier

Example: 69aeb71ef8c5b278e3bab4e5
toolIdstringOptional

Tool identifier

Example: 69aeb71ef8c5b278e3bab4e5
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation.

application/json
get/artifacts
GET /api/v1/artifacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-16T09:31:27.902Z",
    "updateDate": "2026-03-16T09:31:28.042Z",
    "uuid": "dcc46b7b-3bb8-4a60-8e5b-f7b17ae76d1e",
    "policyId": "69b7cdefa48bb15eb7afb3e7",
    "name": "region_emission_factors",
    "type": "JSON",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "extention": "json",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "id": "69b7cdefa48bb15eb7afb3e5"
  },
  {
    "createDate": "2026-03-16T09:31:27.898Z",
    "updateDate": "2026-03-16T09:31:28.042Z",
    "uuid": "ba6f7bc5-0f91-46a5-a681-1658f93a1b68",
    "policyId": "69b7cdefa48bb15eb7afb3e7",
    "name": "country_emission_factors",
    "type": "JSON",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "extention": "json",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "id": "69b7cdefa48bb15eb7afb3e3"
  }
]

Upload artifact.

post

Upload artifact. For users with the Standard Registry role only.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
parentIdstringRequired

Parent ID

Example: 69aeb71ef8c5b278e3bab4e5
Body
artifactsstring · binary[]Required

Artifact files

Responses
201

Artifacts uploaded successfully.

application/json
createDatestringRequiredExample: 2026-03-19T11:23:34.247Z
updateDatestringRequiredExample: 2026-03-19T11:23:34.247Z
uuidstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
policyIdstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
namestringRequiredExample: country_emission_factors
typestring · enumRequiredExample: JSONPossible values:
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
extentionstringRequiredExample: json
categorystring · enumOptionalExample: policyPossible values:
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
idstringRequiredExample: 69aeb71ef8c5b278e3bab4e5
post/artifacts/{parentId}
POST /api/v1/artifacts/{parentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 31

{
  "artifacts": [
    "<binary file>"
  ]
}
[
  {
    "createDate": "2026-03-19T14:43:45.250Z",
    "updateDate": "2026-03-19T14:43:45.250Z",
    "uuid": "d5fc05d5-efc8-4b00-80d7-020374361452",
    "policyId": "69ba978163637d350db5b56f",
    "name": "1_profile_preset",
    "type": "JSON",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "extention": "json",
    "category": "policy",
    "id": "69bc0ba1f6b2fa8ae50f2ec9"
  }
]

Delete artifact.

delete

Delete artifact.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
artifactIdstringRequired

Artifact ID

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
booleanOptional
delete/artifacts/{artifactId}
DELETE /api/v1/artifacts/{artifactId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Download file by id.

get

Returns file from GridFS by its identifier.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
fileIdstringRequired

File identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
201

Successful operation. Returns file content.

application/octet-stream
string · binaryOptional
get/artifacts/files/{fileId}
GET /api/v1/artifacts/files/{fileId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Delete file by id

delete

Deletes file from GridFS by _id

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
fileIdstringRequired

File identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
booleanOptional
delete/artifacts/files/{fileId}
DELETE /api/v1/artifacts/files/{fileId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Uploads/overwrites file

post

Uploads/overwrites file in GridFS

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
filestring · binaryOptional
fileIdstringOptional

Existing file _id to overwrite (optional)

Example: 69aeb71ef8c5b278e3bab4e5
Responses
201

File uploaded successfully.

application/json
fileIdstringRequired

File identifier

Example: 67b8f31d2a26f8be2a9f0be9
filenamestringRequired

Saved file name

Example: file
contentTypestringRequired

Saved file content type

Example: application/json
post/artifacts/files
POST /api/v1/artifacts/files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 53

{
  "file": "binary",
  "fileId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "fileId": "69bc1d9df6b2fa8ae50f2edc",
  "filename": "file",
  "contentType": "application/json"
}

Last updated