Repositories API
Actions in the repositories namespace of the Nexigon Hub API.
repositories_ResolveName
POST/api/v1/actions/invoke/repositories_ResolveNameResolve a repository by its name.
Request ResolveRepositoryNameAction
Fields (JSON object)
repositoryrequiredName of the repository.
string
Response ResolveRepositoryNameOutput
Casesinternally β tag field result
FoundThe repository has been found.
{ "result": "Found", ...<payload fields> } β or "repositoryId" for non-object payloadsRepositoryIdstringNotFoundThe repository has not been found.
This may also be returned if the actor does not have the necessary permissions.
{ "result": "NotFound" }
repositories_GetDetails
POST/api/v1/actions/invoke/repositories_GetDetailsGet information about a repository.
Request GetRepositoryDetailsAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response GetRepositoryDetailsOutput
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringdisplayName(fromdisplay_name)requiredDisplay name of the repository.
stringpublicName(frompublic_name)optionalName of the repository.
stringvisibilityrequiredVisibility of the repository.
RepositoryVisibility
Casesexternally
PublicThe repository is public and can be accessed by anyone.
Value: "Public"PrivateThe repository is private and can only be accessed by its members.
Value: "Private"
packageCount(frompackage_count)requiredNumber of packages in the repository.
integer (i64)assetCount(fromasset_count)requiredNumber of assets in the repository.
integer (i64)
repositories_Create
POST/api/v1/actions/invoke/repositories_CreateCreate a new repository.
Request CreateRepositoryAction
Fields (JSON object)
organizationId(fromorganization_id)requiredOrganization to create the repository in.
OrganizationIdstringnamerequiredName of the repository.
stringvisibilityoptionalVisibility of the repository.
Default to private.
RepositoryVisibility
Casesexternally
PublicThe repository is public and can be accessed by anyone.
Value: "Public"PrivateThe repository is private and can only be accessed by its members.
Value: "Private"
Response CreateRepositoryOutput
Casesinternally β tag field result
NameAlreadyExistsA repository with the same name already exists.
{ "result": "NameAlreadyExists" }CreatedThe repository has been created.
{ "result": "Created", ...<payload fields> } β or "content" for non-object payloadsCreateRepositorySuccess
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
repositories_Delete
POST/api/v1/actions/invoke/repositories_DeleteDelete a repository.
Request DeleteRepositoryAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response Empty
No fields.
repositories_SetVisibility
POST/api/v1/actions/invoke/repositories_SetVisibilitySet the visibility of a repository.
Request SetRepositoryVisibilityAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringvisibilityrequiredNew visibility of the repository.
RepositoryVisibility
Casesexternally
PublicThe repository is public and can be accessed by anyone.
Value: "Public"PrivateThe repository is private and can only be accessed by its members.
Value: "Private"
Response Empty
No fields.
repositories_SetDisplayName
POST/api/v1/actions/invoke/repositories_SetDisplayNameSet the display name of a repository.
Request SetRepositoryDisplayNameAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringdisplayName(fromdisplay_name)optionalNew display name of the repository.
string
Response Empty
No fields.
repositories_SetPublicName
POST/api/v1/actions/invoke/repositories_SetPublicNameSet the public name of a repository.
Note: Setting the public name requires the public_repositories subscription feature.
Request SetRepositoryPublicNameAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringpublicName(frompublic_name)requiredNew public name of the repository.
string
Response SetRepositoryPublicNameOutput
Casesinternally β tag field result
NameAlreadyExistsA repository with the same public name already exists.
{ "result": "NameAlreadyExists" }SuccessThe public name has been set.
{ "result": "Success" }
repositories_QueryPackages
POST/api/v1/actions/invoke/repositories_QueryPackagesQuery the packages of a repository.
Request QueryRepositoryPackagesAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response QueryRepositoryPackagesOutput
Fields (JSON object)
packagesrequiredList of packages.
array<QueryRepositoryPackagesItem>
Items
QueryRepositoryPackagesItem
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringnamerequiredName of the package.
stringkindoptionalFree-form kind of the package (e.g., "rugix-app").
stringcreatedAt(fromcreated_at)requiredTimestamp when the package was created.
Timestampstring
repositories_QueryAssets
POST/api/v1/actions/invoke/repositories_QueryAssetsQuery the assets of a repository.
Request QueryRepositoryAssetsAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response QueryRepositoryAssetsOutput
Fields (JSON object)
assetsrequiredList of assets.
array<QueryRepositoryAssetsItem>
Items
QueryRepositoryAssetsItem
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstringsizerequiredSize of the asset.
integer (i64)digestrequiredDigest of the asset.
Digeststring
repositories_QueryLinkedProjects
POST/api/v1/actions/invoke/repositories_QueryLinkedProjectsQuery repository projects.
Request QueryRepositoryProjectsAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response QueryRepositoryProjectsOutput
Fields (JSON object)
projectsrequiredList of projects.
array<QueryRepositoryProjectsItem>
Items
QueryRepositoryProjectsItem
Fields (JSON object)
projectId(fromproject_id)requiredID of the project.
ProjectIdstringnamerequiredName of the project.
string
repositories_ResolvePackageByPath
POST/api/v1/actions/invoke/repositories_ResolvePackageByPathResolve a package by its path.
Request ResolvePackageByPathAction
Fields (JSON object)
repositoryrequiredName of the repository.
stringpackagerequiredName of the package.
string
Response ResolvePackageByPathOutput
Casesinternally β tag field result
FoundThe package has been found.
{ "result": "Found", ...<payload fields> } β or "content" for non-object payloadsResolvePackageByPathSuccess
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringpackageId(frompackage_id)requiredID of the package.
PackageIdstring
NotFoundThe package has not been found.
{ "result": "NotFound" }
repositories_GetPackageDetails
POST/api/v1/actions/invoke/repositories_GetPackageDetailsGet information about a package.
Request GetPackageDetailsAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstring
Response GetPackageDetailsOutput
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringnamerequiredName of the package.
stringkindoptionalFree-form kind of the package (e.g., "rugix-app").
stringversionCount(fromversion_count)requiredNumber of versions of the package.
integer (i64)metadatarequiredPackage-level metadata.
object<string, JsonValue>
Keys
stringValues
JsonValueanyassetsrequiredAssets attached to the package itself (independent of versions). Used by the package-level VEX flow but generic β anything that wants to live on the package can be attached here.
array<PackageAsset>
Items
PackageAsset
Fields (JSON object)
assetId(fromasset_id)requiredRepositoryAssetIdstringfilenamerequiredstringsizerequiredinteger (i64)digestrequiredDigeststringstatusrequiredRepositoryAssetStatus
Casesexternally
DanglingThe asset has been created but not yet uploaded.
Value: "Dangling"AvailableThe asset has been uploaded and is available.
Value: "Available"DeletingThe asset is in the process of being deleted.
Value: "Deleting"
metadatarequiredobject<string, JsonValue>
Keys
stringValues
JsonValueany
repositories_AddPackageAsset
POST/api/v1/actions/invoke/repositories_AddPackageAssetAttach a repository asset to a package under the given filename.
Symmetric to AddPackageVersionAssetAction but for the package
itself rather than a specific version. The asset must already exist
in the same repository; the link carries an arbitrary metadata
dictionary.
Request AddPackageAssetAction
Fields (JSON object)
packageId(frompackage_id)requiredPackageIdstringassetId(fromasset_id)requiredRepositoryAssetIdstringfilenamerequiredstringmetadataoptionalobject<string, JsonValue>
Keys
stringValues
JsonValueany
Response AddPackageAssetOutput
Casesinternally β tag field result
FilenameAlreadyExistsAn asset with the same filename already exists on this package.
{ "result": "FilenameAlreadyExists" }AddedThe asset has been added.
{ "result": "Added" }
repositories_RemovePackageAsset
POST/api/v1/actions/invoke/repositories_RemovePackageAssetRemove a package asset by filename.
Request RemovePackageAssetAction
Fields (JSON object)
packageId(frompackage_id)requiredPackageIdstringfilenamerequiredstring
Response Empty
No fields.
repositories_SetPackageAssetMetadata
POST/api/v1/actions/invoke/repositories_SetPackageAssetMetadataReplace the metadata on a package asset.
Request SetPackageAssetMetadataAction
Fields (JSON object)
packageId(frompackage_id)requiredPackageIdstringfilenamerequiredstringmetadatarequiredobject<string, JsonValue>
Keys
stringValues
JsonValueany
Response Empty
No fields.
repositories_CreatePackage
POST/api/v1/actions/invoke/repositories_CreatePackageCreate a new package.
Request CreatePackageAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringnamerequiredName of the package.
stringkindoptionalFree-form kind of the package (e.g., "rugix-app").
stringmetadataoptionalOptional initial metadata.
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response CreatePackageOutput
Casesinternally β tag field result
NameAlreadyExistsA package with the same name already exists.
{ "result": "NameAlreadyExists" }CreatedThe package has been created.
{ "result": "Created", ...<payload fields> } β or "content" for non-object payloadsCreatePackageSuccess
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstring
repositories_DeletePackage
POST/api/v1/actions/invoke/repositories_DeletePackageDelete a package.
Request DeletePackageAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstring
Response Empty
No fields.
repositories_SetPackageMetadata
POST/api/v1/actions/invoke/repositories_SetPackageMetadataSet metadata on a package.
Request SetPackageMetadataAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringmetadatarequiredMetadata to set (replaces existing metadata).
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response Empty
No fields.
repositories_SetPackageKind
POST/api/v1/actions/invoke/repositories_SetPackageKindSet the kind of a package.
Request SetPackageKindAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringkindoptionalNew kind of the package (e.g., "rugix-app"), or null to clear.
string
Response Empty
No fields.
repositories_SetPackageName
POST/api/v1/actions/invoke/repositories_SetPackageNameSet the name of a package.
Request SetPackageNameAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringnamerequiredNew name of the package.
string
Response SetPackageNameOutput
Casesinternally β tag field result
NameAlreadyExistsA package with the same name already exists.
{ "result": "NameAlreadyExists" }SuccessThe name has been set.
{ "result": "Success" }
repositories_QueryPackageVersions
POST/api/v1/actions/invoke/repositories_QueryPackageVersionsQuery the versions of a package.
Request QueryPackageVersionsAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstring
Response QueryPackageVersionsOutput
Fields (JSON object)
versionsrequiredList of package versions.
array<QueryPackageVersionsItem>
Items
QueryPackageVersionsItem
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringnameoptionalOptional name of the version.
stringcreatedAt(fromcreated_at)requiredTimestamp when the package version was created.
TimestampstringtagsrequiredTags of the package version.
array<PackageVersionTag>
Items
PackageVersionTag
Fields (JSON object)
tagrequiredTag of the package version.
stringlockedrequiredIndicates whether the tag is locked.
boolean
repositories_ResolveVersionByPath
POST/api/v1/actions/invoke/repositories_ResolveVersionByPathResolve a package version by its path.
Request ResolvePackageVersionByPathAction
Fields (JSON object)
repositoryrequiredName of the repository.
stringpackagerequiredName of the package.
stringtagrequiredTag of the version.
string
Response ResolvePackageVersionByPathOutput
Casesinternally β tag field result
FoundThe package version has been found.
{ "result": "Found", ...<payload fields> } β or "content" for non-object payloadsResolvePackageVersionByPathSuccess
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringpackageId(frompackage_id)requiredID of the package.
PackageIdstringversionId(fromversion_id)requiredID of the package version.
PackageVersionIdstring
NotFoundThe package version has not been found.
{ "result": "NotFound" }
repositories_GetVersionDetails
POST/api/v1/actions/invoke/repositories_GetVersionDetailsGet information about a package version.
Request GetPackageVersionDetailsAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstring
Response GetPackageVersionDetailsOutput
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringrepositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringpackageId(frompackage_id)requiredID of the package.
PackageIdstringnameoptionalOptional name of the version.
stringassetsrequiredAssets of the version.
array<PackageVersionAsset>
Items
PackageVersionAsset
Fields (JSON object)
filenamerequiredFilename of the asset.
stringassetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstringsizerequiredSize of the asset.
integer (i64)digestrequiredDigest of the asset.
DigeststringstatusrequiredStatus of the asset.
RepositoryAssetStatus
Casesexternally
DanglingThe asset has been created but not yet uploaded.
Value: "Dangling"AvailableThe asset has been uploaded and is available.
Value: "Available"DeletingThe asset is in the process of being deleted.
Value: "Deleting"
metadatarequiredArbitrary metadata associated with this asset in the version.
object<string, JsonValue>
Keys
stringValues
JsonValueany
tagsrequiredTags of the version.
array<PackageVersionTag>
Items
PackageVersionTag
Fields (JSON object)
tagrequiredTag of the package version.
stringlockedrequiredIndicates whether the tag is locked.
boolean
metadatarequiredVersion-level metadata.
object<string, JsonValue>
Keys
stringValues
JsonValueany
repositories_CreateVersion
POST/api/v1/actions/invoke/repositories_CreateVersionCreate a new package version.
Request CreatePackageVersionAction
Fields (JSON object)
packageId(frompackage_id)requiredID of the package.
PackageIdstringnameoptionalOptional name of the version.
stringtagsoptionalTags to add to the package version.
array<AddTagItem>
Items
AddTagItem
Fields (JSON object)
tagrequiredTag to add.
stringlockedoptionalIndicates whether the tag should be locked.
Default to false.
booleanreassignoptionalIndicates whether the tag should be reassigned, if it already exists.
Defaults to true.
boolean
metadataoptionalOptional initial metadata.
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response CreatePackageVersionOutput
Casesinternally β tag field result
CreatedThe package version has been created.
{ "result": "Created", ...<payload fields> } β or "content" for non-object payloadsCreatePackageVersionSuccess
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstring
repositories_DeleteVersion
POST/api/v1/actions/invoke/repositories_DeleteVersionDelete a package version.
Request DeletePackageVersionAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstring
Response Empty
No fields.
repositories_SetVersionName
POST/api/v1/actions/invoke/repositories_SetVersionNameSet the name of a package version.
Request SetPackageVersionNameAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringnameoptionalNew name of the package version.
string
Response Empty
No fields.
repositories_SetVersionMetadata
POST/api/v1/actions/invoke/repositories_SetVersionMetadataSet metadata on a package version.
Request SetPackageVersionMetadataAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringmetadatarequiredMetadata to set (replaces existing metadata).
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response Empty
No fields.
repositories_AddVersionAsset
POST/api/v1/actions/invoke/repositories_AddVersionAssetAdd an asset to a package version.
Request AddPackageVersionAssetAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringassetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstringfilenamerequiredFilename of the asset.
stringmetadataoptionalOptional metadata to associate with this asset in the version.
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response AddPackageVersionAssetOutput
Casesinternally β tag field result
FilenameAlreadyExistsAn asset with the same filename already exists.
{ "result": "FilenameAlreadyExists" }AddedThe asset has been added to the package version.
{ "result": "Added" }
repositories_RemoveVersionAsset
POST/api/v1/actions/invoke/repositories_RemoveVersionAssetRemove an asset from a package version.
Request RemovePackageVersionAssetAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringfilenamerequiredFilename of the asset.
string
Response Empty
No fields.
repositories_SetVersionAssetMetadata
POST/api/v1/actions/invoke/repositories_SetVersionAssetMetadataSet metadata on a package version asset.
Request SetPackageVersionAssetMetadataAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringfilenamerequiredFilename of the asset.
stringmetadatarequiredMetadata to set (replaces existing metadata).
object<string, JsonValue>
Keys
stringValues
JsonValueany
Response Empty
No fields.
repositories_TagVersion
POST/api/v1/actions/invoke/repositories_TagVersionAdd tags to a version.
Request TagPackageVersionAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringtagsrequiredTags to add.
array<AddTagItem>
Items
AddTagItem
Fields (JSON object)
tagrequiredTag to add.
stringlockedoptionalIndicates whether the tag should be locked.
Default to false.
booleanreassignoptionalIndicates whether the tag should be reassigned, if it already exists.
Defaults to true.
boolean
Response Empty
No fields.
repositories_UntagVersion
POST/api/v1/actions/invoke/repositories_UntagVersionRemove tags from a version.
Request UntagPackageVersionAction
Fields (JSON object)
versionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringtagsrequiredTags to remove.
array<RemoveTagItem>
Items
RemoveTagItem
Fields (JSON object)
tagrequiredTag to remove.
string
Response Empty
No fields.
repositories_ResolveVersionAssetByPath
POST/api/v1/actions/invoke/repositories_ResolveVersionAssetByPathResolve a version asset by its path.
Request ResolvePackageVersionAssetByPathAction
Fields (JSON object)
repositoryrequiredName of the repository.
stringpackagerequiredName of the package.
stringtagrequiredTag of the version.
stringfilenamerequiredFilename of the asset.
string
Response ResolvePackageVersionAssetByPathOutput
Casesinternally β tag field result
FoundThe asset has been found.
{ "result": "Found", ...<payload fields> } β or "content" for non-object payloadsResolvePackageVersionAssetByPathSuccess
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringpackageId(frompackage_id)requiredID of the package.
PackageIdstringversionId(fromversion_id)requiredID of the package version.
PackageVersionIdstringassetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstring
NotFoundThe asset has not been found.
{ "result": "NotFound" }
repositories_SetS3Config
POST/api/v1/actions/invoke/repositories_SetS3ConfigSet the S3 configuration for the repository.
Request SetRepositoryS3ConfigAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstrings3Config(froms3_config)requiredS3 config for the repository.
RepositoryS3Config
Fields (JSON object)
endpointrequiredS3 endpoint (e.g., https://s3.amazonaws.com or https://minio.local:9000).
stringbucketrequiredS3 bucket name.
stringregionoptionalAWS region (required by AWS, may be NULL for MinIO/other providers).
stringprefixoptionalOptional prefix inside the bucket to scope this repository.
stringaccessKeyId(fromaccess_key_id)requiredS3 access key ID (not sensitive, can be plain text).
stringsecretAccessKey(fromsecret_access_key)optionalS3 secret access key (sensitive, will be stored encrypted).
string
Response Empty
No fields.
repositories_GetS3Config
POST/api/v1/actions/invoke/repositories_GetS3ConfigGet the S3 configuration for the repository.
Request GetRepositoryS3ConfigAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response GetRepositoryS3ConfigOutput
Fields (JSON object)
s3Config(froms3_config)requiredS3 config for the repository.
RepositoryS3Config
Fields (JSON object)
endpointrequiredS3 endpoint (e.g., https://s3.amazonaws.com or https://minio.local:9000).
stringbucketrequiredS3 bucket name.
stringregionoptionalAWS region (required by AWS, may be NULL for MinIO/other providers).
stringprefixoptionalOptional prefix inside the bucket to scope this repository.
stringaccessKeyId(fromaccess_key_id)requiredS3 access key ID (not sensitive, can be plain text).
stringsecretAccessKey(fromsecret_access_key)optionalS3 secret access key (sensitive, will be stored encrypted).
string
repositories_GetAssetDetails
POST/api/v1/actions/invoke/repositories_GetAssetDetailsGet information about an asset.
Request GetAssetDetailsAction
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstring
Response GetAssetDetailsOutput
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstringsizerequiredSize of the asset.
integer (i64)digestrequiredDigest of the asset.
DigeststringstatusrequiredStatus of the asset.
RepositoryAssetStatus
Casesexternally
DanglingThe asset has been created but not yet uploaded.
Value: "Dangling"AvailableThe asset has been uploaded and is available.
Value: "Available"DeletingThe asset is in the process of being deleted.
Value: "Deleting"
referenceCount(fromreference_count)requiredNumber of package versions that refer to the asset.
integer (i64)
repositories_CreateAsset
POST/api/v1/actions/invoke/repositories_CreateAssetCreate an asset.
Request CreateAssetAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstringsizerequiredSize of the asset.
integer (i64)digestrequiredDigest of the asset.
Digeststring
Response CreateAssetOutput
Casesinternally β tag field result
AssetAlreadyExistsAn asset with the same digest already exists.
{ "result": "AssetAlreadyExists", ...<payload fields> } β or "assetId" for non-object payloadsRepositoryAssetIdstringCreatedThe asset has been created.
{ "result": "Created", ...<payload fields> } β or "assetId" for non-object payloadsRepositoryAssetIdstring
repositories_DeleteAsset
POST/api/v1/actions/invoke/repositories_DeleteAssetDelete an asset.
Request DeleteAssetAction
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset.
RepositoryAssetIdstring
Response Empty
No fields.
repositories_IssueAssetDownloadUrl
POST/api/v1/actions/invoke/repositories_IssueAssetDownloadUrlIssue a URL for downloading an asset.
Request IssueAssetDownloadUrlAction
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset to issue the URL for.
RepositoryAssetIdstringfilenameoptionalOptional filename for the asset.
string
Response IssueAssetDownloadUrlOutput
Fields (JSON object)
urlrequiredURL for downloading the asset.
string
repositories_IssueAssetUploadUrl
POST/api/v1/actions/invoke/repositories_IssueAssetUploadUrlIssue a URL for uploading an asset.
Request IssueAssetUploadUrlAction
Fields (JSON object)
assetId(fromasset_id)requiredID of the asset to issue the URL for.
RepositoryAssetIdstring
Response IssueAssetUploadUrlOutput
Fields (JSON object)
urlrequiredURL for uploading the asset.
string
repositories_QueryAuditLog
POST/api/v1/actions/invoke/repositories_QueryAuditLogQuery the audit log of the repository.
Request QueryAuditLogEventsAction
Fields (JSON object)
repositoryId(fromrepository_id)requiredID of the repository.
RepositoryIdstring
Response QueryAuditLogEventsOutput
Fields (JSON object)
eventsrequiredList of audit log events.
array<AuditLogEvent>
Items
AuditLogEvent
Fields (JSON object)
eventId(fromevent_id)requiredID of the audit log event.
AuditLogEventIdstringactorrequiredActor causing the event.
Actor
Casesinternally β tag field
actorAnonymousAn anonymous, unauthenticated actor.
{ "actor": "Anonymous", ...<payload fields> } β or "content" for non-object payloadsAnonymousActor
No fields.
SystemThe system itself, typically used for internal actions.
{ "actor": "System", ...<payload fields> } β or "content" for non-object payloadsSystemActor
No fields.
DeviceA device authenticated via a specific deployment token.
{ "actor": "Device", ...<payload fields> } β or "content" for non-object payloadsDeviceActor
Fields (JSON object)
deviceId(fromdevice_id)requiredID of the device.
DeviceIdstringtokenId(fromtoken_id)requiredID of the deployment token used for authentication.
DeploymentTokenIdstring
UserA user typically authenticated via a user session.
{ "actor": "User", ...<payload fields> } β or "content" for non-object payloadsUserActor
Fields (JSON object)
userId(fromuser_id)requiredID of the user.
UserIdstring
UserTokenA user authenticated via a specific token.
{ "actor": "UserToken", ...<payload fields> } β or "content" for non-object payloadsUserTokenActor
Fields (JSON object)
userId(fromuser_id)requiredID of the user.
UserIdstringtokenId(fromtoken_id)requiredID of the user token used for authentication.
UserTokenIdstring
ClusterNodeA cluster node.
{ "actor": "ClusterNode", ...<payload fields> } β or "content" for non-object payloadsClusterNodeActor
Fields (JSON object)
nodeId(fromnode_id)requiredID of the cluster node.
ClusterNodeIdstring
OrganizationApiTokenAn organization API token.
{ "actor": "OrganizationApiToken", ...<payload fields> } β or "content" for non-object payloadsOrganizationApiTokenActor
Fields (JSON object)
organizationId(fromorganization_id)requiredID of the organization.
OrganizationIdstringtokenId(fromtoken_id)requiredID of the API token.
OrganizationApiTokenIdstring
eventrequiredType of the event that was recorded.
stringdatarequiredAdditional audit data associated with the event.
JsonValueanycreatedAt(fromcreated_at)requiredTimestamp indicating when the audit log event was recorded.
TimestampstringactionoptionalAction the event has been caused by (if any).
AuditLogEventAction
Fields (JSON object)
actionId(fromaction_id)requiredID of the action.
AuditLogActionIdstring
joboptionalJob the event has been caused by (if any).
AuditLogEventJob
Fields (JSON object)
jobId(fromjob_id)requiredID of the job.
JobIdstring