Skip to main content
Documentation

Repositories API

Actions in the repositories namespace of the Nexigon Hub API.

repositories_ResolveName

POST /api/v1/actions/invoke/repositories_ResolveName

Resolve a repository by its name.

Request ResolveRepositoryNameAction

  • repository required

    Name of the repository.

    string

Response ResolveRepositoryNameOutput

  • Found

    The repository has been found.

    { "result": "Found", ...<payload fields> } β€” or "repositoryId" for non-object payloads

    RepositoryId string
  • NotFound

    The 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_GetDetails

Get information about a repository.

Request GetRepositoryDetailsAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response GetRepositoryDetailsOutput

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • displayName (from display_name) required

    Display name of the repository.

    string
  • publicName (from public_name) optional

    Name of the repository.

    string
  • visibility required

    Visibility of the repository.

    RepositoryVisibility
    • Public

      The repository is public and can be accessed by anyone.

      Value: "Public"

    • Private

      The repository is private and can only be accessed by its members.

      Value: "Private"

  • packageCount (from package_count) required

    Number of packages in the repository.

    integer (i64)
  • assetCount (from asset_count) required

    Number of assets in the repository.

    integer (i64)

repositories_Create

POST /api/v1/actions/invoke/repositories_Create

Create a new repository.

Request CreateRepositoryAction

  • organizationId (from organization_id) required

    Organization to create the repository in.

    OrganizationId string
  • name required

    Name of the repository.

    string
  • visibility optional

    Visibility of the repository.

    Default to private.

    RepositoryVisibility
    • Public

      The repository is public and can be accessed by anyone.

      Value: "Public"

    • Private

      The repository is private and can only be accessed by its members.

      Value: "Private"

Response CreateRepositoryOutput

  • NameAlreadyExists

    A repository with the same name already exists.

    { "result": "NameAlreadyExists" }

  • Created

    The repository has been created.

    { "result": "Created", ...<payload fields> } β€” or "content" for non-object payloads

    CreateRepositorySuccess
    • repositoryId (from repository_id) required

      ID of the repository.

      RepositoryId string

repositories_Delete

POST /api/v1/actions/invoke/repositories_Delete

Delete a repository.

Request DeleteRepositoryAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response Empty

No fields.

repositories_SetVisibility

POST /api/v1/actions/invoke/repositories_SetVisibility

Set the visibility of a repository.

Request SetRepositoryVisibilityAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • visibility required

    New visibility of the repository.

    RepositoryVisibility
    • Public

      The repository is public and can be accessed by anyone.

      Value: "Public"

    • Private

      The 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_SetDisplayName

Set the display name of a repository.

Request SetRepositoryDisplayNameAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • displayName (from display_name) optional

    New display name of the repository.

    string

Response Empty

No fields.

repositories_SetPublicName

POST /api/v1/actions/invoke/repositories_SetPublicName

Set the public name of a repository.

Note: Setting the public name requires the public_repositories subscription feature.

Request SetRepositoryPublicNameAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • publicName (from public_name) required

    New public name of the repository.

    string

Response SetRepositoryPublicNameOutput

  • NameAlreadyExists

    A repository with the same public name already exists.

    { "result": "NameAlreadyExists" }

  • Success

    The public name has been set.

    { "result": "Success" }

repositories_QueryPackages

POST /api/v1/actions/invoke/repositories_QueryPackages

Query the packages of a repository.

Request QueryRepositoryPackagesAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response QueryRepositoryPackagesOutput

  • packages required

    List of packages.

    array<QueryRepositoryPackagesItem>
    QueryRepositoryPackagesItem
    • packageId (from package_id) required

      ID of the package.

      PackageId string
    • name required

      Name of the package.

      string
    • kind optional

      Free-form kind of the package (e.g., "rugix-app").

      string
    • createdAt (from created_at) required

      Timestamp when the package was created.

      Timestamp string

repositories_QueryAssets

POST /api/v1/actions/invoke/repositories_QueryAssets

Query the assets of a repository.

Request QueryRepositoryAssetsAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response QueryRepositoryAssetsOutput

  • assets required

    List of assets.

    array<QueryRepositoryAssetsItem>
    QueryRepositoryAssetsItem
    • assetId (from asset_id) required

      ID of the asset.

      RepositoryAssetId string
    • size required

      Size of the asset.

      integer (i64)
    • digest required

      Digest of the asset.

      Digest string

repositories_QueryLinkedProjects

POST /api/v1/actions/invoke/repositories_QueryLinkedProjects

Query repository projects.

Request QueryRepositoryProjectsAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response QueryRepositoryProjectsOutput

  • projects required

    List of projects.

    array<QueryRepositoryProjectsItem>
    QueryRepositoryProjectsItem
    • projectId (from project_id) required

      ID of the project.

      ProjectId string
    • name required

      Name of the project.

      string

repositories_ResolvePackageByPath

POST /api/v1/actions/invoke/repositories_ResolvePackageByPath

Resolve a package by its path.

Request ResolvePackageByPathAction

  • repository required

    Name of the repository.

    string
  • package required

    Name of the package.

    string

Response ResolvePackageByPathOutput

  • Found

    The package has been found.

    { "result": "Found", ...<payload fields> } β€” or "content" for non-object payloads

    ResolvePackageByPathSuccess
    • repositoryId (from repository_id) required

      ID of the repository.

      RepositoryId string
    • packageId (from package_id) required

      ID of the package.

      PackageId string
  • NotFound

    The package has not been found.

    { "result": "NotFound" }

repositories_GetPackageDetails

POST /api/v1/actions/invoke/repositories_GetPackageDetails

Get information about a package.

Request GetPackageDetailsAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string

Response GetPackageDetailsOutput

  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • name required

    Name of the package.

    string
  • kind optional

    Free-form kind of the package (e.g., "rugix-app").

    string
  • versionCount (from version_count) required

    Number of versions of the package.

    integer (i64)
  • metadata required

    Package-level metadata.

    object<string, JsonValue>
    string
    JsonValue any
  • assets required

    Assets 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>
    PackageAsset
    • assetId (from asset_id) required
      RepositoryAssetId string
    • filename required
      string
    • size required
      integer (i64)
    • digest required
      Digest string
    • status required
      RepositoryAssetStatus
      • Dangling

        The asset has been created but not yet uploaded.

        Value: "Dangling"

      • Available

        The asset has been uploaded and is available.

        Value: "Available"

      • Deleting

        The asset is in the process of being deleted.

        Value: "Deleting"

    • metadata required
      object<string, JsonValue>
      string
      JsonValue any

repositories_AddPackageAsset

POST /api/v1/actions/invoke/repositories_AddPackageAsset

Attach 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

  • packageId (from package_id) required
    PackageId string
  • assetId (from asset_id) required
    RepositoryAssetId string
  • filename required
    string
  • metadata optional
    object<string, JsonValue>
    string
    JsonValue any

Response AddPackageAssetOutput

  • FilenameAlreadyExists

    An asset with the same filename already exists on this package.

    { "result": "FilenameAlreadyExists" }

  • Added

    The asset has been added.

    { "result": "Added" }

repositories_RemovePackageAsset

POST /api/v1/actions/invoke/repositories_RemovePackageAsset

Remove a package asset by filename.

Request RemovePackageAssetAction

  • packageId (from package_id) required
    PackageId string
  • filename required
    string

Response Empty

No fields.

repositories_SetPackageAssetMetadata

POST /api/v1/actions/invoke/repositories_SetPackageAssetMetadata

Replace the metadata on a package asset.

Request SetPackageAssetMetadataAction

  • packageId (from package_id) required
    PackageId string
  • filename required
    string
  • metadata required
    object<string, JsonValue>
    string
    JsonValue any

Response Empty

No fields.

repositories_CreatePackage

POST /api/v1/actions/invoke/repositories_CreatePackage

Create a new package.

Request CreatePackageAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • name required

    Name of the package.

    string
  • kind optional

    Free-form kind of the package (e.g., "rugix-app").

    string
  • metadata optional

    Optional initial metadata.

    object<string, JsonValue>
    string
    JsonValue any

Response CreatePackageOutput

  • NameAlreadyExists

    A package with the same name already exists.

    { "result": "NameAlreadyExists" }

  • Created

    The package has been created.

    { "result": "Created", ...<payload fields> } β€” or "content" for non-object payloads

    CreatePackageSuccess
    • packageId (from package_id) required

      ID of the package.

      PackageId string

repositories_DeletePackage

POST /api/v1/actions/invoke/repositories_DeletePackage

Delete a package.

Request DeletePackageAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string

Response Empty

No fields.

repositories_SetPackageMetadata

POST /api/v1/actions/invoke/repositories_SetPackageMetadata

Set metadata on a package.

Request SetPackageMetadataAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • metadata required

    Metadata to set (replaces existing metadata).

    object<string, JsonValue>
    string
    JsonValue any

Response Empty

No fields.

repositories_SetPackageKind

POST /api/v1/actions/invoke/repositories_SetPackageKind

Set the kind of a package.

Request SetPackageKindAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • kind optional

    New 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_SetPackageName

Set the name of a package.

Request SetPackageNameAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • name required

    New name of the package.

    string

Response SetPackageNameOutput

  • NameAlreadyExists

    A package with the same name already exists.

    { "result": "NameAlreadyExists" }

  • Success

    The name has been set.

    { "result": "Success" }

repositories_QueryPackageVersions

POST /api/v1/actions/invoke/repositories_QueryPackageVersions

Query the versions of a package.

Request QueryPackageVersionsAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string

Response QueryPackageVersionsOutput

  • versions required

    List of package versions.

    array<QueryPackageVersionsItem>
    QueryPackageVersionsItem
    • versionId (from version_id) required

      ID of the package version.

      PackageVersionId string
    • name optional

      Optional name of the version.

      string
    • createdAt (from created_at) required

      Timestamp when the package version was created.

      Timestamp string
    • tags required

      Tags of the package version.

      array<PackageVersionTag>
      PackageVersionTag
      • tag required

        Tag of the package version.

        string
      • locked required

        Indicates whether the tag is locked.

        boolean

repositories_ResolveVersionByPath

POST /api/v1/actions/invoke/repositories_ResolveVersionByPath

Resolve a package version by its path.

Request ResolvePackageVersionByPathAction

  • repository required

    Name of the repository.

    string
  • package required

    Name of the package.

    string
  • tag required

    Tag of the version.

    string

Response ResolvePackageVersionByPathOutput

  • Found

    The package version has been found.

    { "result": "Found", ...<payload fields> } β€” or "content" for non-object payloads

    ResolvePackageVersionByPathSuccess
    • repositoryId (from repository_id) required

      ID of the repository.

      RepositoryId string
    • packageId (from package_id) required

      ID of the package.

      PackageId string
    • versionId (from version_id) required

      ID of the package version.

      PackageVersionId string
  • NotFound

    The package version has not been found.

    { "result": "NotFound" }

repositories_GetVersionDetails

POST /api/v1/actions/invoke/repositories_GetVersionDetails

Get information about a package version.

Request GetPackageVersionDetailsAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string

Response GetPackageVersionDetailsOutput

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • name optional

    Optional name of the version.

    string
  • assets required

    Assets of the version.

    array<PackageVersionAsset>
    PackageVersionAsset
    • filename required

      Filename of the asset.

      string
    • assetId (from asset_id) required

      ID of the asset.

      RepositoryAssetId string
    • size required

      Size of the asset.

      integer (i64)
    • digest required

      Digest of the asset.

      Digest string
    • status required

      Status of the asset.

      RepositoryAssetStatus
      • Dangling

        The asset has been created but not yet uploaded.

        Value: "Dangling"

      • Available

        The asset has been uploaded and is available.

        Value: "Available"

      • Deleting

        The asset is in the process of being deleted.

        Value: "Deleting"

    • metadata required

      Arbitrary metadata associated with this asset in the version.

      object<string, JsonValue>
      string
      JsonValue any
  • tags required

    Tags of the version.

    array<PackageVersionTag>
    PackageVersionTag
    • tag required

      Tag of the package version.

      string
    • locked required

      Indicates whether the tag is locked.

      boolean
  • metadata required

    Version-level metadata.

    object<string, JsonValue>
    string
    JsonValue any

repositories_CreateVersion

POST /api/v1/actions/invoke/repositories_CreateVersion

Create a new package version.

Request CreatePackageVersionAction

  • packageId (from package_id) required

    ID of the package.

    PackageId string
  • name optional

    Optional name of the version.

    string
  • tags optional

    Tags to add to the package version.

    array<AddTagItem>
    AddTagItem
    • tag required

      Tag to add.

      string
    • locked optional

      Indicates whether the tag should be locked.

      Default to false.

      boolean
    • reassign optional

      Indicates whether the tag should be reassigned, if it already exists.

      Defaults to true.

      boolean
  • metadata optional

    Optional initial metadata.

    object<string, JsonValue>
    string
    JsonValue any

Response CreatePackageVersionOutput

  • Created

    The package version has been created.

    { "result": "Created", ...<payload fields> } β€” or "content" for non-object payloads

    CreatePackageVersionSuccess
    • versionId (from version_id) required

      ID of the package version.

      PackageVersionId string

repositories_DeleteVersion

POST /api/v1/actions/invoke/repositories_DeleteVersion

Delete a package version.

Request DeletePackageVersionAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string

Response Empty

No fields.

repositories_SetVersionName

POST /api/v1/actions/invoke/repositories_SetVersionName

Set the name of a package version.

Request SetPackageVersionNameAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • name optional

    New name of the package version.

    string

Response Empty

No fields.

repositories_SetVersionMetadata

POST /api/v1/actions/invoke/repositories_SetVersionMetadata

Set metadata on a package version.

Request SetPackageVersionMetadataAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • metadata required

    Metadata to set (replaces existing metadata).

    object<string, JsonValue>
    string
    JsonValue any

Response Empty

No fields.

repositories_AddVersionAsset

POST /api/v1/actions/invoke/repositories_AddVersionAsset

Add an asset to a package version.

Request AddPackageVersionAssetAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • assetId (from asset_id) required

    ID of the asset.

    RepositoryAssetId string
  • filename required

    Filename of the asset.

    string
  • metadata optional

    Optional metadata to associate with this asset in the version.

    object<string, JsonValue>
    string
    JsonValue any

Response AddPackageVersionAssetOutput

  • FilenameAlreadyExists

    An asset with the same filename already exists.

    { "result": "FilenameAlreadyExists" }

  • Added

    The asset has been added to the package version.

    { "result": "Added" }

repositories_RemoveVersionAsset

POST /api/v1/actions/invoke/repositories_RemoveVersionAsset

Remove an asset from a package version.

Request RemovePackageVersionAssetAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • filename required

    Filename of the asset.

    string

Response Empty

No fields.

repositories_SetVersionAssetMetadata

POST /api/v1/actions/invoke/repositories_SetVersionAssetMetadata

Set metadata on a package version asset.

Request SetPackageVersionAssetMetadataAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • filename required

    Filename of the asset.

    string
  • metadata required

    Metadata to set (replaces existing metadata).

    object<string, JsonValue>
    string
    JsonValue any

Response Empty

No fields.

repositories_TagVersion

POST /api/v1/actions/invoke/repositories_TagVersion

Add tags to a version.

Request TagPackageVersionAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • tags required

    Tags to add.

    array<AddTagItem>
    AddTagItem
    • tag required

      Tag to add.

      string
    • locked optional

      Indicates whether the tag should be locked.

      Default to false.

      boolean
    • reassign optional

      Indicates 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_UntagVersion

Remove tags from a version.

Request UntagPackageVersionAction

  • versionId (from version_id) required

    ID of the package version.

    PackageVersionId string
  • tags required

    Tags to remove.

    array<RemoveTagItem>
    RemoveTagItem
    • tag required

      Tag to remove.

      string

Response Empty

No fields.

repositories_ResolveVersionAssetByPath

POST /api/v1/actions/invoke/repositories_ResolveVersionAssetByPath

Resolve a version asset by its path.

Request ResolvePackageVersionAssetByPathAction

  • repository required

    Name of the repository.

    string
  • package required

    Name of the package.

    string
  • tag required

    Tag of the version.

    string
  • filename required

    Filename of the asset.

    string

Response ResolvePackageVersionAssetByPathOutput

  • Found

    The asset has been found.

    { "result": "Found", ...<payload fields> } β€” or "content" for non-object payloads

    ResolvePackageVersionAssetByPathSuccess
    • repositoryId (from repository_id) required

      ID of the repository.

      RepositoryId string
    • packageId (from package_id) required

      ID of the package.

      PackageId string
    • versionId (from version_id) required

      ID of the package version.

      PackageVersionId string
    • assetId (from asset_id) required

      ID of the asset.

      RepositoryAssetId string
  • NotFound

    The asset has not been found.

    { "result": "NotFound" }

repositories_SetS3Config

POST /api/v1/actions/invoke/repositories_SetS3Config

Set the S3 configuration for the repository.

Request SetRepositoryS3ConfigAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • s3Config (from s3_config) required

    S3 config for the repository.

    RepositoryS3Config
    • endpoint required
      string
    • bucket required

      S3 bucket name.

      string
    • region optional

      AWS region (required by AWS, may be NULL for MinIO/other providers).

      string
    • prefix optional

      Optional prefix inside the bucket to scope this repository.

      string
    • accessKeyId (from access_key_id) required

      S3 access key ID (not sensitive, can be plain text).

      string
    • secretAccessKey (from secret_access_key) optional

      S3 secret access key (sensitive, will be stored encrypted).

      string

Response Empty

No fields.

repositories_GetS3Config

POST /api/v1/actions/invoke/repositories_GetS3Config

Get the S3 configuration for the repository.

Request GetRepositoryS3ConfigAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response GetRepositoryS3ConfigOutput

  • s3Config (from s3_config) required

    S3 config for the repository.

    RepositoryS3Config
    • endpoint required
      string
    • bucket required

      S3 bucket name.

      string
    • region optional

      AWS region (required by AWS, may be NULL for MinIO/other providers).

      string
    • prefix optional

      Optional prefix inside the bucket to scope this repository.

      string
    • accessKeyId (from access_key_id) required

      S3 access key ID (not sensitive, can be plain text).

      string
    • secretAccessKey (from secret_access_key) optional

      S3 secret access key (sensitive, will be stored encrypted).

      string

repositories_GetAssetDetails

POST /api/v1/actions/invoke/repositories_GetAssetDetails

Get information about an asset.

Request GetAssetDetailsAction

  • assetId (from asset_id) required

    ID of the asset.

    RepositoryAssetId string

Response GetAssetDetailsOutput

  • assetId (from asset_id) required

    ID of the asset.

    RepositoryAssetId string
  • size required

    Size of the asset.

    integer (i64)
  • digest required

    Digest of the asset.

    Digest string
  • status required

    Status of the asset.

    RepositoryAssetStatus
    • Dangling

      The asset has been created but not yet uploaded.

      Value: "Dangling"

    • Available

      The asset has been uploaded and is available.

      Value: "Available"

    • Deleting

      The asset is in the process of being deleted.

      Value: "Deleting"

  • referenceCount (from reference_count) required

    Number of package versions that refer to the asset.

    integer (i64)

repositories_CreateAsset

POST /api/v1/actions/invoke/repositories_CreateAsset

Create an asset.

Request CreateAssetAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string
  • size required

    Size of the asset.

    integer (i64)
  • digest required

    Digest of the asset.

    Digest string

Response CreateAssetOutput

  • AssetAlreadyExists

    An asset with the same digest already exists.

    { "result": "AssetAlreadyExists", ...<payload fields> } β€” or "assetId" for non-object payloads

    RepositoryAssetId string
  • Created

    The asset has been created.

    { "result": "Created", ...<payload fields> } β€” or "assetId" for non-object payloads

    RepositoryAssetId string

repositories_DeleteAsset

POST /api/v1/actions/invoke/repositories_DeleteAsset

Delete an asset.

Request DeleteAssetAction

  • assetId (from asset_id) required

    ID of the asset.

    RepositoryAssetId string

Response Empty

No fields.

repositories_IssueAssetDownloadUrl

POST /api/v1/actions/invoke/repositories_IssueAssetDownloadUrl

Issue a URL for downloading an asset.

Request IssueAssetDownloadUrlAction

  • assetId (from asset_id) required

    ID of the asset to issue the URL for.

    RepositoryAssetId string
  • filename optional

    Optional filename for the asset.

    string

Response IssueAssetDownloadUrlOutput

  • url required

    URL for downloading the asset.

    string

repositories_IssueAssetUploadUrl

POST /api/v1/actions/invoke/repositories_IssueAssetUploadUrl

Issue a URL for uploading an asset.

Request IssueAssetUploadUrlAction

  • assetId (from asset_id) required

    ID of the asset to issue the URL for.

    RepositoryAssetId string

Response IssueAssetUploadUrlOutput

  • url required

    URL for uploading the asset.

    string

repositories_QueryAuditLog

POST /api/v1/actions/invoke/repositories_QueryAuditLog

Query the audit log of the repository.

Request QueryAuditLogEventsAction

  • repositoryId (from repository_id) required

    ID of the repository.

    RepositoryId string

Response QueryAuditLogEventsOutput

  • events required

    List of audit log events.

    array<AuditLogEvent>
    AuditLogEvent
    • eventId (from event_id) required

      ID of the audit log event.

      AuditLogEventId string
    • actor required

      Actor causing the event.

      Actor
      • Anonymous

        An anonymous, unauthenticated actor.

        { "actor": "Anonymous", ...<payload fields> } β€” or "content" for non-object payloads

        AnonymousActor

        No fields.

      • System

        The system itself, typically used for internal actions.

        { "actor": "System", ...<payload fields> } β€” or "content" for non-object payloads

        SystemActor

        No fields.

      • Device

        A device authenticated via a specific deployment token.

        { "actor": "Device", ...<payload fields> } β€” or "content" for non-object payloads

        DeviceActor
        • deviceId (from device_id) required

          ID of the device.

          DeviceId string
        • tokenId (from token_id) required

          ID of the deployment token used for authentication.

          DeploymentTokenId string
      • User

        A user typically authenticated via a user session.

        { "actor": "User", ...<payload fields> } β€” or "content" for non-object payloads

        UserActor
        • userId (from user_id) required

          ID of the user.

          UserId string
      • UserToken

        A user authenticated via a specific token.

        { "actor": "UserToken", ...<payload fields> } β€” or "content" for non-object payloads

        UserTokenActor
        • userId (from user_id) required

          ID of the user.

          UserId string
        • tokenId (from token_id) required

          ID of the user token used for authentication.

          UserTokenId string
      • ClusterNode

        A cluster node.

        { "actor": "ClusterNode", ...<payload fields> } β€” or "content" for non-object payloads

        ClusterNodeActor
        • nodeId (from node_id) required

          ID of the cluster node.

          ClusterNodeId string
      • OrganizationApiToken

        An organization API token.

        { "actor": "OrganizationApiToken", ...<payload fields> } β€” or "content" for non-object payloads

        OrganizationApiTokenActor
        • organizationId (from organization_id) required

          ID of the organization.

          OrganizationId string
        • tokenId (from token_id) required

          ID of the API token.

          OrganizationApiTokenId string
    • event required

      Type of the event that was recorded.

      string
    • data required

      Additional audit data associated with the event.

      JsonValue any
    • createdAt (from created_at) required

      Timestamp indicating when the audit log event was recorded.

      Timestamp string
    • action optional

      Action the event has been caused by (if any).

      AuditLogEventAction
      • actionId (from action_id) required

        ID of the action.

        AuditLogActionId string
    • job optional

      Job the event has been caused by (if any).

      AuditLogEventJob
      • jobId (from job_id) required

        ID of the job.

        JobId string