Skip to content
RSXDocs
RSX · API · Reference

registry v1

Software distribution for RSX-built packages: npm and Cargo packages, platform binaries, and OCI images.

Current
Base URL
https://api.rsx.group/registry/v1
Self-grantable scopes
None. Every endpoint here needs a key issued by a platform admin.
Machine readable
openapi.json
01

admin

28 operations under /registry/v1/admin.

GET/registry/v1/admin/native/releases/list

List native releases, newest first, optionally by review state

Scope
registry:admin:native:releases:list Admin-issued keys only.

Query parameters

Query parameters of adminListNativeReleases

  • reviewState
    Type
    string
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • package
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 50

Response 200Releases

Response of adminListNativeReleases

  • datarequired
    Type
    array of RegistryNativeAdminRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/native/releases/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "package": "@rsx/metal",
      "version": "0.6.0",
      "architecture": "x86_64",
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 10240,
      "status": "staging",
      "reviewState": "pending",
      "findings": [
        {
          "check": "manifest.identity",
          "message": "The manifest names 'goodbye', but the release was declared as 'hello'."
        }
      ],
      "manifest": {
        "format": 3,
        "description": "Says hello.",
        "requires": [
          {
            "name": null,
            "version": null
          }
        ]
      },
      "supersedes": [
        "string"
      ],
      "isDefault": true,
      "reviewReason": "string",
      "reviewedAt": "2026-10-10T12:00:00.000Z",
      "revokeCode": "broken",
      "revokeReason": "string",
      "revokedAt": "2026-10-10T12:00:00.000Z",
      "firstGeneration": 1,
      "reviewedBy": "string",
      "revokedBy": "string"
    }
  ]
}
GET/registry/v1/admin/native/releases/get

Read one native release, with its findings and review history

Scope
registry:admin:native:releases:get Admin-issued keys only.

Query parameters

Query parameters of adminGetNativeRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The release

Response of adminGetNativeRelease

  • datarequired
    Type
    RegistryNativeAdminRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/native/releases/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "architecture": "x86_64",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 10240,
    "status": "staging",
    "reviewState": "pending",
    "findings": [
      {
        "check": "manifest.identity",
        "message": "The manifest names 'goodbye', but the release was declared as 'hello'."
      }
    ],
    "manifest": {
      "format": 3,
      "description": "Says hello.",
      "requires": [
        {
          "name": "libfoo",
          "version": "*"
        }
      ]
    },
    "supersedes": [
      "string"
    ],
    "isDefault": true,
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "broken",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1,
    "reviewedBy": "string",
    "revokedBy": "string"
  }
}
POST/registry/v1/admin/native/releases/update

Approve, reject or revoke a native release

Scope
registry:admin:native:releases:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateNativeRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reviewStaterequired
    Type
    string
    Description
    one of "approved", "rejected", "revoked"
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • supersedes
    Type
    array of string
    Description
    up to 32 items
  • revokeCode
    Type
    string
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"

Response 200The release after the decision

Response of adminUpdateNativeRelease

  • datarequired
    Type
    RegistryNativeAdminRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/native/releases/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "version": "0.6.0",
  "reviewState": "approved",
  "reason": "Fixes a crash on start when /etc/hello.conf is missing.",
  "supersedes": [
    "0.6.0"
  ],
  "revokeCode": "broken"
}'
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "architecture": "x86_64",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 10240,
    "status": "staging",
    "reviewState": "pending",
    "findings": [
      {
        "check": "manifest.identity",
        "message": "The manifest names 'goodbye', but the release was declared as 'hello'."
      }
    ],
    "manifest": {
      "format": 3,
      "description": "Says hello.",
      "requires": [
        {
          "name": "libfoo",
          "version": "*"
        }
      ]
    },
    "supersedes": [
      "string"
    ],
    "isDefault": true,
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "broken",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1,
    "reviewedBy": "string",
    "revokedBy": "string"
  }
}
POST/registry/v1/admin/native/packages/update

Set or clear a native package's default release

Scope
registry:admin:native:packages:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateNativePackage

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • defaultVersionrequired
    Type
    string, or null
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The package's default after the change

Response of adminUpdateNativePackage

  • datarequired
    Type
    object
    Description
  • packagerequired
    Type
    string
    Description
  • defaultVersionrequired
    Type
    string, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/native/packages/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "defaultVersion": "0.6.0"
}'
200 response
{
  "data": {
    "package": "string",
    "defaultVersion": "string"
  }
}
GET/registry/v1/admin/native/snapshots/list

List signed generations, newest first

Scope
registry:admin:native:snapshots:list Admin-issued keys only.

Query parameters

Query parameters of adminListNativeSnapshots

  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 50

Response 200Generations

Response of adminListNativeSnapshots

  • datarequired
    Type
    array of RegistryNativeSnapshot
    Description
  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/native/snapshots/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "generation": 1,
      "state": "writing",
      "kind": "publish",
      "keysVersion": 1,
      "keyId": "string",
      "signedAt": "2026-10-10T12:00:00.000Z",
      "expiresAt": "2026-10-10T12:00:00.000Z",
      "payloadSha256": "string",
      "size": 1,
      "releaseCount": 1,
      "publishedBy": "string"
    }
  ]
}
GET/registry/v1/admin/native/snapshots/preview

What a publication would change against the current generation

Scope
registry:admin:native:snapshots:preview Admin-issued keys only.

Response 200The difference a publish would sign

Response of adminPreviewNativeSnapshot

  • datarequired
    Type
    RegistryNativeSnapshotPreview
    Description
  • currentGenerationrequired
    Type
    integer, or null
    Description
  • addedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • architecturerequired
    Type
    string
    Description
  • removedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • architecturerequired
    Type
    string
    Description
  • revokedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • defaultsChangedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • fromrequired
    Type
    string, or null
    Description
  • torequired
    Type
    string, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • unchangedrequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/native/snapshots/preview" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "currentGeneration": 1,
    "added": [
      {
        "package": "string",
        "version": "string",
        "architecture": "string"
      }
    ],
    "removed": [
      {
        "package": "string",
        "version": "string",
        "architecture": "string"
      }
    ],
    "revoked": [
      {
        "package": "string",
        "version": "string"
      }
    ],
    "defaultsChanged": [
      {
        "package": "string",
        "from": "string",
        "to": "string"
      }
    ],
    "releaseCount": 1,
    "unchanged": true
  }
}
POST/registry/v1/admin/native/snapshots/publish

Sign and publish the next generation of the repository

Scope
registry:admin:native:snapshots:publish Admin-issued keys only.

Request bodyapplication/json

Request body of adminPublishNativeSnapshot

  • expectGenerationrequired
    Type
    integer, or null
    Description

Response 200The new current generation

Response of adminPublishNativeSnapshot

  • datarequired
    Type
    RegistryNativeSnapshot
    Description
  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/native/snapshots/publish \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "expectGeneration": 1
}'
200 response
{
  "data": {
    "generation": 1,
    "state": "writing",
    "kind": "publish",
    "keysVersion": 1,
    "keyId": "string",
    "signedAt": "2026-10-10T12:00:00.000Z",
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "payloadSha256": "string",
    "size": 1,
    "releaseCount": 1,
    "publishedBy": "string"
  }
}
GET/registry/v1/admin/native/keys/get

The repository's root keys, keys document and signing key status

Scope
registry:admin:native:keys:get Admin-issued keys only.

Response 200Key status. Never any private key material.

Response of adminGetNativeKeys

  • datarequired
    Type
    RegistryNativeKeysStatus
    Description
  • repositoryrequired
    Type
    string
    Description
  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/native/keys/get" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "repository": "string",
    "rootKeyIds": [
      "string"
    ],
    "keysVersion": 1,
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "onlineKeyIds": [
      "string"
    ],
    "signingKeyId": "string",
    "signingKeyListed": true
  }
}
POST/registry/v1/admin/native/keys/update

Upload a keys document signed offline with a root key

Scope
registry:admin:native:keys:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateNativeKeys

  • enveloperequired
    Type
    string
    Description
    1 to 65536 characters

Response 200Key status after the upload

Response of adminUpdateNativeKeys

  • datarequired
    Type
    RegistryNativeKeysStatus
    Description
  • repositoryrequired
    Type
    string
    Description
  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/native/keys/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "envelope": "string"
}'
200 response
{
  "data": {
    "repository": "string",
    "rootKeyIds": [
      "string"
    ],
    "keysVersion": 1,
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "onlineKeyIds": [
      "string"
    ],
    "signingKeyId": "string",
    "signingKeyListed": true
  }
}
GET/registry/v1/admin/app/applications/list

List applications with visibility, channels and pending reviews

Scope
registry:admin:app:applications:list Admin-issued keys only.

Response 200Applications

Response of adminListApplications

  • datarequired
    Type
    array of RegistryAppApplication
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string, or null
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • pendingCountrequired
    Type
    integer
    Description
  • identitiesrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • identityrequired
    Type
    string
    Description
  • pinnedVersionrequired
    Type
    string
    Description
  • pinnedAtrequired
    Type
    string, date-time
    Description
  • updatedByrequired
    Type
    string, or null
    Description
  • updatedAtrequired
    Type
    string, date-time, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/applications/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "package": "@rsx/metal",
      "visibility": "public",
      "appId": "string",
      "displayName": "string",
      "summary": "string",
      "homepageUrl": "string",
      "docsUrl": "string",
      "channels": {
        "key": "string"
      },
      "releaseCount": 1,
      "pendingCount": 1,
      "identities": [
        {
          "platform": "windows-x86_64-msix",
          "identity": "string",
          "pinnedVersion": "string",
          "pinnedAt": "2026-10-10T12:00:00.000Z"
        }
      ],
      "updatedBy": "string",
      "updatedAt": "2026-10-10T12:00:00.000Z"
    }
  ]
}
GET/registry/v1/admin/app/applications/get

Read one application

Scope
registry:admin:app:applications:get Admin-issued keys only.

Query parameters

Query parameters of adminGetApplication

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

Response 200The application

Response of adminGetApplication

  • datarequired
    Type
    RegistryAppApplication
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string, or null
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • pendingCountrequired
    Type
    integer
    Description
  • identitiesrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • identityrequired
    Type
    string
    Description
  • pinnedVersionrequired
    Type
    string
    Description
  • pinnedAtrequired
    Type
    string, date-time
    Description
  • updatedByrequired
    Type
    string, or null
    Description
  • updatedAtrequired
    Type
    string, date-time, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/applications/get?package=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "visibility": "public",
    "appId": "string",
    "displayName": "string",
    "summary": "string",
    "homepageUrl": "string",
    "docsUrl": "string",
    "channels": {
      "key": "string"
    },
    "releaseCount": 1,
    "pendingCount": 1,
    "identities": [
      {
        "platform": "windows-x86_64-msix",
        "identity": "string",
        "pinnedVersion": "string",
        "pinnedAt": "2026-10-10T12:00:00.000Z"
      }
    ],
    "updatedBy": "string",
    "updatedAt": "2026-10-10T12:00:00.000Z"
  }
}
POST/registry/v1/admin/app/applications/update

Change an application's visibility, app id or catalogue metadata

Scope
registry:admin:app:applications:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateApplication

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibility
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appId
    Type
    string
    Description
    up to 128 characters · matches ^[a-z][a-z0-9-]*(?:\.[a-z][a-z0-9-]*)+$
  • displayName
    Type
    string, or null
    Description
    1 to 80 characters
  • summary
    Type
    string, or null
    Description
    1 to 280 characters
  • homepageUrl
    Type
    string, uri, or null
    Description
    up to 512 characters
  • docsUrl
    Type
    string, uri, or null
    Description
    up to 512 characters

Response 200The application after the change

Response of adminUpdateApplication

  • datarequired
    Type
    RegistryAppApplication
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string, or null
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • pendingCountrequired
    Type
    integer
    Description
  • identitiesrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • identityrequired
    Type
    string
    Description
  • pinnedVersionrequired
    Type
    string
    Description
  • pinnedAtrequired
    Type
    string, date-time
    Description
  • updatedByrequired
    Type
    string, or null
    Description
  • updatedAtrequired
    Type
    string, date-time, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/app/applications/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "visibility": "public",
  "appId": "group.rsx.link",
  "displayName": "string",
  "summary": "string",
  "homepageUrl": "https://example.com/",
  "docsUrl": "https://example.com/"
}'
200 response
{
  "data": {
    "package": "@rsx/metal",
    "visibility": "public",
    "appId": "string",
    "displayName": "string",
    "summary": "string",
    "homepageUrl": "string",
    "docsUrl": "string",
    "channels": {
      "key": "string"
    },
    "releaseCount": 1,
    "pendingCount": 1,
    "identities": [
      {
        "platform": "windows-x86_64-msix",
        "identity": "string",
        "pinnedVersion": "string",
        "pinnedAt": "2026-10-10T12:00:00.000Z"
      }
    ],
    "updatedBy": "string",
    "updatedAt": "2026-10-10T12:00:00.000Z"
  }
}
GET/registry/v1/admin/app/releases/list

List application releases, newest first, optionally by review state

Scope
registry:admin:app:releases:list Admin-issued keys only.

Query parameters

Query parameters of adminListAppReleases

  • reviewState
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • package
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 50

Response 200Releases

Response of adminListAppReleases

  • datarequired
    Type
    array of RegistryAppAdminRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/releases/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "package": "@rsx/metal",
      "version": "0.6.0",
      "status": "staging",
      "reviewState": "pending",
      "assets": [
        {
          "platform": "windows-x86_64-msix",
          "os": "string",
          "arch": "string",
          "format": "string",
          "mediaType": "string",
          "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
          "size": 1,
          "uploaded": true,
          "outcome": "valid",
          "findings": [
            null
          ],
          "notes": [
            null
          ],
          "identity": "string",
          "facts": {
            "key": null
          }
        }
      ],
      "notes": "string",
      "requirements": {
        "key": {
          "minOsVersion": "10.0.22621.0",
          "notes": "string"
        }
      },
      "channels": [
        "stable"
      ],
      "reviewReason": "string",
      "reviewedAt": "2026-10-10T12:00:00.000Z",
      "revokeCode": "security",
      "revokeReason": "string",
      "revokedAt": "2026-10-10T12:00:00.000Z",
      "firstGeneration": 1,
      "visibility": "public",
      "reviewedBy": "string",
      "revokedBy": "string",
      "createdAt": "2026-10-10T12:00:00.000Z"
    }
  ]
}
GET/registry/v1/admin/app/releases/get

Read one application release with its assets, findings and review history

Scope
registry:admin:app:releases:get Admin-issued keys only.

Query parameters

Query parameters of adminGetAppRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The release

Response of adminGetAppRelease

  • datarequired
    Type
    RegistryAppAdminRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/releases/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "status": "staging",
    "reviewState": "pending",
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "mediaType": "string",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 1,
        "uploaded": true,
        "outcome": "valid",
        "findings": [
          null
        ],
        "notes": [
          null
        ],
        "identity": "string",
        "facts": {
          "key": null
        }
      }
    ],
    "notes": "string",
    "requirements": {
      "key": {
        "minOsVersion": "10.0.22621.0",
        "notes": "string"
      }
    },
    "channels": [
      "stable"
    ],
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "security",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1,
    "visibility": "public",
    "reviewedBy": "string",
    "revokedBy": "string",
    "createdAt": "2026-10-10T12:00:00.000Z"
  }
}
POST/registry/v1/admin/app/releases/update

Approve, reject or revoke an application release

Scope
registry:admin:app:releases:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateAppRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reviewStaterequired
    Type
    string
    Description
    one of "approved", "rejected", "revoked"
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • revokeCode
    Type
    string
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"

Response 200The release after the decision, and for a revocation the publication

Response of adminUpdateAppRelease

  • datarequired
    Type
    RegistryAppReleaseDecision
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publicationrequired
    Type
    one of object, object, any, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/app/releases/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "version": "0.6.0",
  "reviewState": "approved",
  "reason": "Fixes a crash on start when /etc/hello.conf is missing.",
  "revokeCode": "security"
}'
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "status": "staging",
    "reviewState": "pending",
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "mediaType": "string",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 1,
        "uploaded": true,
        "outcome": "valid",
        "findings": [
          null
        ],
        "notes": [
          null
        ],
        "identity": "string",
        "facts": {
          "key": null
        }
      }
    ],
    "notes": "string",
    "requirements": {
      "key": {
        "minOsVersion": "10.0.22621.0",
        "notes": "string"
      }
    },
    "channels": [
      "stable"
    ],
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "security",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1,
    "visibility": "public",
    "reviewedBy": "string",
    "revokedBy": "string",
    "createdAt": "2026-10-10T12:00:00.000Z",
    "publication": {
      "repository": "public",
      "generation": 1
    }
  }
}
POST/registry/v1/admin/app/channels/update

Point a channel at an approved release, or clear it

Scope
registry:admin:app:channels:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateAppChannel

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • channelrequired
    Type
    string
    Description
    one of "stable", "beta", "canary"
  • versionrequired
    Type
    string, or null
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • allowDowngrade
    Type
    boolean
    Description

Response 200The application after the change

Response of adminUpdateAppChannel

  • datarequired
    Type
    RegistryAppApplication
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string, or null
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • pendingCountrequired
    Type
    integer
    Description
  • identitiesrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • identityrequired
    Type
    string
    Description
  • pinnedVersionrequired
    Type
    string
    Description
  • pinnedAtrequired
    Type
    string, date-time
    Description
  • updatedByrequired
    Type
    string, or null
    Description
  • updatedAtrequired
    Type
    string, date-time, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/app/channels/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "channel": "stable",
  "version": "0.6.0",
  "reason": "Fixes a crash on start when /etc/hello.conf is missing.",
  "allowDowngrade": true
}'
200 response
{
  "data": {
    "package": "@rsx/metal",
    "visibility": "public",
    "appId": "string",
    "displayName": "string",
    "summary": "string",
    "homepageUrl": "string",
    "docsUrl": "string",
    "channels": {
      "key": "string"
    },
    "releaseCount": 1,
    "pendingCount": 1,
    "identities": [
      {
        "platform": "windows-x86_64-msix",
        "identity": "string",
        "pinnedVersion": "string",
        "pinnedAt": "2026-10-10T12:00:00.000Z"
      }
    ],
    "updatedBy": "string",
    "updatedAt": "2026-10-10T12:00:00.000Z"
  }
}
GET/registry/v1/admin/app/snapshots/list

List one repository's signed generations, newest first

Scope
registry:admin:app:snapshots:list Admin-issued keys only.

Query parameters

Query parameters of adminListAppSnapshots

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 30

Response 200Generations

Response of adminListAppSnapshots

  • datarequired
    Type
    array of RegistryAppSnapshot
    Description
  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/snapshots/list?repository=public" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "repository": "public",
      "generation": 1,
      "state": "writing",
      "kind": "publish",
      "keysVersion": 1,
      "keyId": "string",
      "signedAt": "2026-10-10T12:00:00.000Z",
      "expiresAt": "2026-10-10T12:00:00.000Z",
      "payloadSha256": "string",
      "size": 1,
      "releaseCount": 1,
      "publishedBy": "string"
    }
  ]
}
GET/registry/v1/admin/app/snapshots/preview

What a publication of one repository would change

Scope
registry:admin:app:snapshots:preview Admin-issued keys only.

Query parameters

Query parameters of adminPreviewAppSnapshot

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"

Response 200The difference a publish would sign

Response of adminPreviewAppSnapshot

  • datarequired
    Type
    RegistryAppSnapshotPreview
    Description
  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • currentGenerationrequired
    Type
    integer, or null
    Description
  • addedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • removedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • revokedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • channelsChangedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • channelrequired
    Type
    string
    Description
  • fromrequired
    Type
    string, or null
    Description
  • torequired
    Type
    string, or null
    Description
  • applicationCountrequired
    Type
    integer
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • unchangedrequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/snapshots/preview?repository=public" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "repository": "public",
    "currentGeneration": 1,
    "added": [
      {
        "package": "string",
        "version": "string"
      }
    ],
    "removed": [
      {
        "package": "string",
        "version": "string"
      }
    ],
    "revoked": [
      {
        "package": "string",
        "version": "string"
      }
    ],
    "channelsChanged": [
      {
        "package": "string",
        "channel": "string",
        "from": "string",
        "to": "string"
      }
    ],
    "applicationCount": 1,
    "releaseCount": 1,
    "unchanged": true
  }
}
POST/registry/v1/admin/app/snapshots/publish

Sign and publish the next generation of one repository

Scope
registry:admin:app:snapshots:publish Admin-issued keys only.

Request bodyapplication/json

Request body of adminPublishAppSnapshot

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • expectGenerationrequired
    Type
    integer, or null
    Description
    at least 1

Response 200The new current generation

Response of adminPublishAppSnapshot

  • datarequired
    Type
    RegistryAppSnapshot
    Description
  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/app/snapshots/publish \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "repository": "public",
  "expectGeneration": 1
}'
200 response
{
  "data": {
    "repository": "public",
    "generation": 1,
    "state": "writing",
    "kind": "publish",
    "keysVersion": 1,
    "keyId": "string",
    "signedAt": "2026-10-10T12:00:00.000Z",
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "payloadSha256": "string",
    "size": 1,
    "releaseCount": 1,
    "publishedBy": "string"
  }
}
GET/registry/v1/admin/app/keys/get

The application repositories' root keys, keys document and signing key status

Scope
registry:admin:app:keys:get Admin-issued keys only.

Response 200Key status. Never any private key material.

Response of adminGetAppKeys

  • datarequired
    Type
    RegistryAppKeysStatus
    Description
  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/keys/get" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "rootKeyIds": [
      "string"
    ],
    "keysVersion": 1,
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "onlineKeyIds": [
      "string"
    ],
    "signingKeyId": "string",
    "signingKeyListed": true
  }
}
POST/registry/v1/admin/app/keys/update

Upload a keys document signed offline with a root key

Scope
registry:admin:app:keys:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateAppKeys

  • enveloperequired
    Type
    string
    Description
    1 to 65536 characters

Response 200Key status after the upload

Response of adminUpdateAppKeys

  • datarequired
    Type
    RegistryAppKeysStatus
    Description
  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/admin/app/keys/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "envelope": "string"
}'
200 response
{
  "data": {
    "rootKeyIds": [
      "string"
    ],
    "keysVersion": 1,
    "expiresAt": "2026-10-10T12:00:00.000Z",
    "onlineKeyIds": [
      "string"
    ],
    "signingKeyId": "string",
    "signingKeyListed": true
  }
}
GET/registry/v1/admin/app/assets/download

Download one stored installer, of any visibility or review state

Scope
registry:admin:app:assets:download Admin-issued keys only.

Query parameters

Query parameters of adminDownloadAppAsset

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"

Response 200The installer bytes

The bytes, with their content type.

Example

curl
curl "https://api.rsx.group/registry/v1/admin/app/assets/download?package=%40rsx%2Fmetal&version=0.6.0&platform=windows-x86_64-msix" \
  -H "Authorization: Bearer rsx_live_..."
GET/registry/v1/admin/packages/list

What there is to choose from

Scope
registry:admin:packages:list Admin-issued keys only.

Query parameters

Query parameters of adminListRegistryPackages

  • protocol
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scope
    Type
    string
    Description
    up to 128 characters
  • owner
    Type
    string
    Description
    up to 128 characters
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Packages, with each one's newest published version

Response of adminListRegistryPackages

  • datarequired
    Type
    array of RegistryPackage
    Description
  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/packages/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
      "name": "@rsx/metal",
      "protocol": "npm",
      "scope": "@rsx",
      "visibility": "internal",
      "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77",
      "description": "Roblox place and asset build tooling.",
      "latest": "0.6.0",
      "versionCount": 12,
      "createdAt": "2026-09-04T10:15:00.000Z",
      "updatedAt": "2026-09-04T10:15:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/registry/v1/admin/versions/list

A package's versions, newest first

Scope
registry:admin:versions:list Admin-issued keys only.

Query parameters

Query parameters of adminListRegistryVersions

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Versions

Response of adminListRegistryVersions

  • datarequired
    Type
    array of RegistryVersion
    Description
  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/versions/list?protocol=npm&name=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d11",
      "protocol": "npm",
      "name": "@rsx/metal",
      "version": "0.6.0",
      "status": "published",
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 8419372,
      "artefacts": [
        {
          "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
          "platform": "linux-x86_64",
          "mediaType": "application/vnd.npm.install-v1+tgz",
          "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
          "size": 8419372,
          "stored": true,
          "createdAt": "2026-09-04T10:15:00.000Z"
        }
      ],
      "createdAt": "2026-09-04T10:15:00.000Z",
      "publishedAt": "2026-09-04T10:16:30.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/registry/v1/admin/oci/resolve

Turn a tag into the digest a node is given

The one route here that is not a listing. A deployment is pinned to a digest, never a tag, so something has to do this lookup — and doing it once, centrally, at the moment an operator chooses, is what stops a digest being copied by hand out of a CI run summary.

Scope
registry:admin:oci:resolve Admin-issued keys only.

Query parameters

Query parameters of adminResolveRegistryManifest

  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • referencerequired
    Type
    string
    Description
    1 to 255 characters

Response 200The manifest the reference names

Response of adminResolveRegistryManifest

  • datarequired
    Type
    RegistryResolvedManifest
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • referencerequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • sizerequired
    Type
    integer
    Description
  • imagerequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/oci/resolve?name=%40rsx%2Fmetal&reference=2.1.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "name": "@rsx/metal",
    "reference": "2.1.0",
    "digest": "sha256:435afee8e09be01ef873f7a72438f5d43f8589a20019803941357dcd7d482a95",
    "mediaType": "application/vnd.npm.install-v1+tgz",
    "size": 1022,
    "image": "registry.rsx.group/rsx/roxy@sha256:435afee8e09be01ef873f7a72438f5d43f8589a20019803941357dcd7d482a95"
  }
}
GET/registry/v1/admin/binary/list

Builds of a binary package

Scope
registry:admin:binary:list Admin-issued keys only.

Query parameters

Query parameters of adminListRegistryBinaries

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • version
    Type
    string
    Description
    Restrict to one release. Omitted, every published release is listed.1 to 128 characters

Response 200Every platform artefact of every published release

Response of adminListRegistryBinaries

  • datarequired
    Type
    array of RegistryBinaryArtefact
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • downloadrequired
    Type
    string
    Description
    Path to fetch the bytes from, using the same API key.

Example

curl
curl "https://api.rsx.group/registry/v1/admin/binary/list?package=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "package": "@rsx/metal",
      "version": "0.6.0",
      "platform": "linux-x86_64",
      "mediaType": "application/vnd.npm.install-v1+tgz",
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 41983122,
      "download": "/registry/v1/binary/download?package=rsx-node&version=0.8.0&platform=linux-x86_64"
    }
  ]
}
GET/registry/v1/admin/binary/get

One platform artefact, with its digest

What node/v1 turns into an update command. The version, the digest and the path to the bytes come back together or not at all, which is the whole reason this beats three fields pasted from a run summary.

Scope
registry:admin:binary:get Admin-issued keys only.

Query parameters

Query parameters of adminGetRegistryBinary

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$

Response 200The artefact, and where to fetch its bytes

Response of adminGetRegistryBinary

  • datarequired
    Type
    RegistryBinaryArtefact
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • downloadrequired
    Type
    string
    Description
    Path to fetch the bytes from, using the same API key.

Example

curl
curl "https://api.rsx.group/registry/v1/admin/binary/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "platform": "linux-x86_64",
    "mediaType": "application/vnd.npm.install-v1+tgz",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 41983122,
    "download": "/registry/v1/binary/download?package=rsx-node&version=0.8.0&platform=linux-x86_64"
  }
}
GET/registry/v1/admin/audit/list

What has been published, withdrawn and transferred

Newest first. Publication is the one write on this service a non-operator key can reach, so actor is usually an API key id rather than a person.

Scope
registry:admin:audit:list Admin-issued keys only.

Query parameters

Query parameters of adminListRegistryAudit

  • protocol
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • targetType
    Type
    string
    Description
    What the event was about.one of "package", "version", "snapshot", "keys"
  • targetId
    Type
    string
    Description
    up to 128 characters
  • actor
    Type
    string
    Description
    up to 128 characters
  • action
    Type
    string
    Description
    Dotted and past tense, matching the platform's other trails.1 to 64 characters
  • offset
    Type
    integer, or null
    Description
    at least 0 · default 0
  • limit
    Type
    integer
    Description
    1 to 100 · default 50

Response 200Audit events

Response of adminListRegistryAudit

  • datarequired
    Type
    array of RegistryAuditEvent
    Description
  • idrequired
    Type
    string
    Description
  • actorrequired
    Type
    string
    Description
  • actionrequired
    Type
    string
    Description
    Dotted and past tense, matching the platform's other trails.1 to 64 characters
  • targetTyperequired
    Type
    string
    Description
    What the event was about.one of "package", "version", "snapshot", "keys"
  • targetIdrequired
    Type
    string
    Description
  • targetLabelrequired
    Type
    string, or null
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • atrequired
    Type
    string, date-time
    Description
  • detailrequired
    Type
    string, or null
    Description
  • metarequired
    Type
    object
    Description
  • offsetrequired
    Type
    integer
    Description
  • limitrequired
    Type
    integer
    Description
  • morerequired
    Type
    boolean
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/admin/audit/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d12",
      "actor": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d13",
      "action": "version.published",
      "targetType": "version",
      "targetId": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
      "targetLabel": "@rsx/metal 1.4.0",
      "protocol": "npm",
      "at": "2026-09-04T10:16:30.000Z",
      "detail": "3 artefacts, 41.9 MB"
    }
  ],
  "meta": {
    "offset": 1,
    "limit": 1,
    "more": true
  }
}
02

catalogue

4 operations under /registry/v1/catalogue.

GET/registry/v1/catalogue/applications/list

Public applications in the current signed repository

Scope
registry:catalogue:applications:list Admin-issued keys only.

Response 200Applications with at least one eligible release

Response of catalogueListApplications

  • datarequired
    Type
    array of RegistryCatalogueApplication
    Description
  • namerequired
    Type
    string
    Description
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • platformsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/catalogue/applications/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "name": "link",
      "appId": "string",
      "displayName": "string",
      "summary": "string",
      "homepageUrl": "string",
      "docsUrl": "string",
      "channels": {
        "key": "string"
      },
      "platforms": [
        {
          "platform": "windows-x86_64-msix",
          "os": "string",
          "arch": "string",
          "format": "string",
          "label": "string"
        }
      ]
    }
  ]
}
GET/registry/v1/catalogue/applications/get

One public application

Scope
registry:catalogue:applications:get Admin-issued keys only.

Query parameters

Query parameters of catalogueGetApplication

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

Response 200The application

Response of catalogueGetApplication

  • datarequired
    Type
    RegistryCatalogueApplication
    Description
  • namerequired
    Type
    string
    Description
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • platformsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/catalogue/applications/get?package=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "name": "link",
    "appId": "string",
    "displayName": "string",
    "summary": "string",
    "homepageUrl": "string",
    "docsUrl": "string",
    "channels": {
      "key": "string"
    },
    "platforms": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "label": "string"
      }
    ]
  }
}
GET/registry/v1/catalogue/releases/list

A public application's signed releases, newest first, revoked ones marked

Scope
registry:catalogue:releases:list Admin-issued keys only.

Query parameters

Query parameters of catalogueListReleases

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

Response 200Releases

Response of catalogueListReleases

  • datarequired
    Type
    array of RegistryCatalogueRelease
    Description
  • versionrequired
    Type
    string
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    array of string
    Description
  • revokedrequired
    Type
    object, or null
    Description
  • coderequired
    Type
    string
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • reasonrequired
    Type
    string
    Description
  • revokedAtrequired
    Type
    string, date-time
    Description
  • assetsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • sha256required
    Type
    string
    Description
  • minOsVersionrequired
    Type
    string, or null
    Description
  • requirementNotesrequired
    Type
    string, or null
    Description
  • identityrequired
    Type
    string, or null
    Description
  • filenamerequired
    Type
    string
    Description
  • downloadUrlrequired
    Type
    string, or null
    Description
  • signedInrequired
    Type
    object, or null
    Description
  • generationrequired
    Type
    integer
    Description
  • snapshotUrlrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/catalogue/releases/list?package=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "version": "string",
      "publishedAt": "2026-10-10T12:00:00.000Z",
      "notes": "string",
      "channels": [
        "stable"
      ],
      "revoked": {
        "code": "security",
        "reason": "string",
        "revokedAt": "2026-10-10T12:00:00.000Z"
      },
      "assets": [
        {
          "platform": "windows-x86_64-msix",
          "os": "string",
          "arch": "string",
          "format": "string",
          "label": "string",
          "size": 1,
          "sha256": "string",
          "minOsVersion": "string",
          "requirementNotes": "string",
          "identity": "string",
          "filename": "string",
          "downloadUrl": "string"
        }
      ],
      "signedIn": {
        "generation": 1,
        "snapshotUrl": "string"
      }
    }
  ]
}
GET/registry/v1/catalogue/releases/get

One signed release of a public application, with its downloads

Scope
registry:catalogue:releases:get Admin-issued keys only.

Query parameters

Query parameters of catalogueGetRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The release

Response of catalogueGetRelease

  • datarequired
    Type
    RegistryCatalogueRelease
    Description
  • versionrequired
    Type
    string
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    array of string
    Description
  • revokedrequired
    Type
    object, or null
    Description
  • coderequired
    Type
    string
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • reasonrequired
    Type
    string
    Description
  • revokedAtrequired
    Type
    string, date-time
    Description
  • assetsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • sha256required
    Type
    string
    Description
  • minOsVersionrequired
    Type
    string, or null
    Description
  • requirementNotesrequired
    Type
    string, or null
    Description
  • identityrequired
    Type
    string, or null
    Description
  • filenamerequired
    Type
    string
    Description
  • downloadUrlrequired
    Type
    string, or null
    Description
  • signedInrequired
    Type
    object, or null
    Description
  • generationrequired
    Type
    integer
    Description
  • snapshotUrlrequired
    Type
    string
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/catalogue/releases/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "version": "string",
    "publishedAt": "2026-10-10T12:00:00.000Z",
    "notes": "string",
    "channels": [
      "stable"
    ],
    "revoked": {
      "code": "security",
      "reason": "string",
      "revokedAt": "2026-10-10T12:00:00.000Z"
    },
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "label": "string",
        "size": 1,
        "sha256": "string",
        "minOsVersion": "string",
        "requirementNotes": "string",
        "identity": "string",
        "filename": "string",
        "downloadUrl": "string"
      }
    ],
    "signedIn": {
      "generation": 1,
      "snapshotUrl": "string"
    }
  }
}
03

binary

4 operations under /registry/v1/binary.

GET/registry/v1/binary/list

List a binary package's platform artefacts

Scope
registry:binary:list Admin-issued keys only.

Query parameters

Query parameters of listRegistryBinaries

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • version
    Type
    string
    Description
    Restrict to one release. Omitted, every published release is listed.1 to 128 characters

Response 200Artefacts across the requested releases

Response of listRegistryBinaries

  • datarequired
    Type
    array of RegistryBinaryArtefact
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • downloadrequired
    Type
    string
    Description
    Path to fetch the bytes from, using the same API key.

Example

curl
curl "https://api.rsx.group/registry/v1/binary/list?package=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "package": "@rsx/metal",
      "version": "0.6.0",
      "platform": "linux-x86_64",
      "mediaType": "application/vnd.npm.install-v1+tgz",
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 41983122,
      "download": "/registry/v1/binary/download?package=rsx-node&version=0.8.0&platform=linux-x86_64"
    }
  ]
}
GET/registry/v1/binary/get

Read one platform artefact's metadata

Scope
registry:binary:get Admin-issued keys only.

Query parameters

Query parameters of getRegistryBinary

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$

Response 200The artefact, and where to fetch its bytes

Response of getRegistryBinary

  • datarequired
    Type
    RegistryBinaryArtefact
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • downloadrequired
    Type
    string
    Description
    Path to fetch the bytes from, using the same API key.

Example

curl
curl "https://api.rsx.group/registry/v1/binary/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "platform": "linux-x86_64",
    "mediaType": "application/vnd.npm.install-v1+tgz",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 41983122,
    "download": "/registry/v1/binary/download?package=rsx-node&version=0.8.0&platform=linux-x86_64"
  }
}
GET/registry/v1/binary/download

Fetch a platform artefact's bytes

Scope
registry:binary:download Admin-issued keys only.

Query parameters

Query parameters of downloadRegistryBinary

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$

Response 200The artefact bytes, with their verified digest in Docker-Content-Digest

The bytes, with their content type.

Example

curl
curl "https://api.rsx.group/registry/v1/binary/download?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
PUT/registry/v1/binary/upload

Send a declared artefact's bytes

Scope
registry:binary:upload Admin-issued keys only.

Query parameters

Query parameters of uploadRegistryBinary

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.

Request bodyapplication/octet-stream

The artefact bytes. Must declare a Content-Length, and must hash to the digest the release declared.

The raw bytes, as the body.

Response 200The release, published once this was the last outstanding artefact

Response of uploadRegistryBinary

  • datarequired
    Type
    RegistryVersion
    Description
  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.

Example

curl
curl -X PUT https://api.rsx.group/registry/v1/binary/upload \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/octet-stream" \
  --data-binary @file
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d11",
    "protocol": "npm",
    "name": "@rsx/metal",
    "version": "0.6.0",
    "status": "published",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 8419372,
    "artefacts": [
      {
        "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
        "platform": "linux-x86_64",
        "mediaType": "application/vnd.npm.install-v1+tgz",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 8419372,
        "stored": true,
        "createdAt": "2026-09-04T10:15:00.000Z"
      }
    ],
    "createdAt": "2026-09-04T10:15:00.000Z",
    "publishedAt": "2026-09-04T10:16:30.000Z"
  }
}
04

native

2 operations under /registry/v1/native.

GET/registry/v1/native/get

Read a native release's validation and review state

Scope
registry:native:get Admin-issued keys only.

Query parameters

Query parameters of getRegistryNativeRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The release: whether it validated, how it was reviewed, and whether it is in the repository

Response of getRegistryNativeRelease

  • datarequired
    Type
    RegistryNativeRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/native/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "architecture": "x86_64",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 10240,
    "status": "staging",
    "reviewState": "pending",
    "findings": [
      {
        "check": "manifest.identity",
        "message": "The manifest names 'goodbye', but the release was declared as 'hello'."
      }
    ],
    "manifest": {
      "format": 3,
      "description": "Says hello.",
      "requires": [
        {
          "name": "libfoo",
          "version": "*"
        }
      ]
    },
    "supersedes": [
      "string"
    ],
    "isDefault": true,
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "broken",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1
  }
}
PUT/registry/v1/native/upload

Send a declared native release's archive

Scope
registry:native:upload Admin-issued keys only.

Query parameters

Query parameters of uploadRegistryNativeArchive

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.

Request bodyapplication/octet-stream

The .native archive. Must declare a Content-Length, hash to the declared digest, pass Native's archive validation, and be the release that was declared.

The raw bytes, as the body.

Response 200The release, published and pending review

Response of uploadRegistryNativeArchive

  • datarequired
    Type
    RegistryNativeRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

Example

curl
curl -X PUT https://api.rsx.group/registry/v1/native/upload \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/octet-stream" \
  --data-binary @file
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "architecture": "x86_64",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 10240,
    "status": "staging",
    "reviewState": "pending",
    "findings": [
      {
        "check": "manifest.identity",
        "message": "The manifest names 'goodbye', but the release was declared as 'hello'."
      }
    ],
    "manifest": {
      "format": 3,
      "description": "Says hello.",
      "requires": [
        {
          "name": "libfoo",
          "version": "*"
        }
      ]
    },
    "supersedes": [
      "string"
    ],
    "isDefault": true,
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "broken",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1
  }
}
05

app

3 operations under /registry/v1/app.

GET/registry/v1/app/get

Read an application release's validation and review state

Scope
registry:app:get Admin-issued keys only.

Query parameters

Query parameters of getRegistryAppRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The release: each asset's validation, the review, channels and revocation

Response of getRegistryAppRelease

  • datarequired
    Type
    RegistryAppRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/app/get?package=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "status": "staging",
    "reviewState": "pending",
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "mediaType": "string",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 1,
        "uploaded": true,
        "outcome": "valid",
        "findings": [
          {
            "check": null,
            "message": null
          }
        ],
        "notes": [
          {
            "check": null,
            "message": null
          }
        ],
        "identity": "string",
        "facts": {
          "key": "string"
        }
      }
    ],
    "notes": "string",
    "requirements": {
      "key": {
        "minOsVersion": "10.0.22621.0",
        "notes": "string"
      }
    },
    "channels": [
      "stable"
    ],
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "security",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1
  }
}
POST/registry/v1/app/update

Set a release's notes and per-platform requirements before it is reviewed

Scope
registry:app:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateRegistryAppRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • notes
    Type
    string, or null
    Description
    up to 20000 characters
  • requirements
    Type
    object
    Description
  • windows-x86_64-msix
    Type
    RegistryAppRequirement
    Description
  • windows-x86_64-exe
    Type
    RegistryAppRequirement
    Description
  • debian-amd64-deb
    Type
    RegistryAppRequirement
    Description
  • android-arm64-v8a-apk
    Type
    RegistryAppRequirement
    Description

Response 200The release with its details

Response of updateRegistryAppRelease

  • datarequired
    Type
    RegistryAppRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/app/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "package": "@rsx/metal",
  "version": "0.6.0",
  "notes": "string",
  "requirements": {
    "windows-x86_64-msix": {
      "minOsVersion": "10.0.22621.0",
      "notes": "string"
    },
    "windows-x86_64-exe": {
      "minOsVersion": "10.0.22621.0",
      "notes": "string"
    },
    "debian-amd64-deb": {
      "minOsVersion": "10.0.22621.0",
      "notes": "string"
    },
    "android-arm64-v8a-apk": {
      "minOsVersion": "10.0.22621.0",
      "notes": "string"
    }
  }
}'
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "status": "staging",
    "reviewState": "pending",
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "mediaType": "string",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 1,
        "uploaded": true,
        "outcome": "valid",
        "findings": [
          {
            "check": null,
            "message": null
          }
        ],
        "notes": [
          {
            "check": null,
            "message": null
          }
        ],
        "identity": "string",
        "facts": {
          "key": "string"
        }
      }
    ],
    "notes": "string",
    "requirements": {
      "key": {
        "minOsVersion": "10.0.22621.0",
        "notes": "string"
      }
    },
    "channels": [
      "stable"
    ],
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "security",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1
  }
}
PUT/registry/v1/app/upload

Send one declared installer of an application release

Scope
registry:app:upload Admin-issued keys only.

Query parameters

Query parameters of uploadRegistryAppAsset

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.

Request bodyapplication/octet-stream

The installer. Must declare a Content-Length, hash to a declared digest, and pass validation for its platform.

The raw bytes, as the body.

Response 200The release; pending review once its last asset has validated

Response of uploadRegistryAppAsset

  • datarequired
    Type
    RegistryAppRelease
    Description
  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

Example

curl
curl -X PUT https://api.rsx.group/registry/v1/app/upload \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/octet-stream" \
  --data-binary @file
200 response
{
  "data": {
    "package": "@rsx/metal",
    "version": "0.6.0",
    "status": "staging",
    "reviewState": "pending",
    "assets": [
      {
        "platform": "windows-x86_64-msix",
        "os": "string",
        "arch": "string",
        "format": "string",
        "mediaType": "string",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 1,
        "uploaded": true,
        "outcome": "valid",
        "findings": [
          {
            "check": null,
            "message": null
          }
        ],
        "notes": [
          {
            "check": null,
            "message": null
          }
        ],
        "identity": "string",
        "facts": {
          "key": "string"
        }
      }
    ],
    "notes": "string",
    "requirements": {
      "key": {
        "minOsVersion": "10.0.22621.0",
        "notes": "string"
      }
    },
    "channels": [
      "stable"
    ],
    "reviewReason": "string",
    "reviewedAt": "2026-10-10T12:00:00.000Z",
    "revokeCode": "security",
    "revokeReason": "string",
    "revokedAt": "2026-10-10T12:00:00.000Z",
    "firstGeneration": 1
  }
}
06

packages

5 operations under /registry/v1/packages.

GET/registry/v1/packages/list

List packages

Scope
registry:packages:list Admin-issued keys only.

Query parameters

Query parameters of listRegistryPackages

  • protocol
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scope
    Type
    string
    Description
    up to 128 characters
  • owner
    Type
    string
    Description
    up to 128 characters
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Packages, ordered by protocol and name

Response of listRegistryPackages

  • datarequired
    Type
    array of RegistryPackage
    Description
  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/packages/list" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
      "name": "@rsx/metal",
      "protocol": "npm",
      "scope": "@rsx",
      "visibility": "internal",
      "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77",
      "description": "Roblox place and asset build tooling.",
      "latest": "0.6.0",
      "versionCount": 12,
      "createdAt": "2026-09-04T10:15:00.000Z",
      "updatedAt": "2026-09-04T10:15:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/registry/v1/packages/get

Read package metadata

Scope
registry:packages:get Admin-issued keys only.

Query parameters

Query parameters of getRegistryPackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

Response 200The package

Response of getRegistryPackage

  • datarequired
    Type
    RegistryPackage
    Description
  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/packages/get?protocol=npm&name=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
    "name": "@rsx/metal",
    "protocol": "npm",
    "scope": "@rsx",
    "visibility": "internal",
    "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77",
    "description": "Roblox place and asset build tooling.",
    "latest": "0.6.0",
    "versionCount": 12,
    "createdAt": "2026-09-04T10:15:00.000Z",
    "updatedAt": "2026-09-04T10:15:00.000Z"
  }
}
POST/registry/v1/packages/add

Create a package identity

Scope
registry:packages:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of addRegistryPackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • description
    Type
    string
    Description
    up to 512 characters

Response 200The package

Response of addRegistryPackage

  • datarequired
    Type
    RegistryPackage
    Description
  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/packages/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "protocol": "npm",
  "name": "@rsx/metal",
  "description": "string"
}'
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
    "name": "@rsx/metal",
    "protocol": "npm",
    "scope": "@rsx",
    "visibility": "internal",
    "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77",
    "description": "Roblox place and asset build tooling.",
    "latest": "0.6.0",
    "versionCount": 12,
    "createdAt": "2026-09-04T10:15:00.000Z",
    "updatedAt": "2026-09-04T10:15:00.000Z"
  }
}
POST/registry/v1/packages/update

Amend package metadata

Scope
registry:packages:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateRegistryPackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • description
    Type
    string, or null
    Description
    up to 512 characters
  • owner
    Type
    string
    Description
    Transfer ownership. The current owner only.1 to 128 characters

Response 200The package

Response of updateRegistryPackage

  • datarequired
    Type
    RegistryPackage
    Description
  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

Example

curl
curl -X POST https://api.rsx.group/registry/v1/packages/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "protocol": "npm",
  "name": "@rsx/metal",
  "description": "string",
  "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77"
}'
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
    "name": "@rsx/metal",
    "protocol": "npm",
    "scope": "@rsx",
    "visibility": "internal",
    "owner": "3f1c9b02-7a54-4a0e-9c1f-2b8d4e6a1c77",
    "description": "Roblox place and asset build tooling.",
    "latest": "0.6.0",
    "versionCount": 12,
    "createdAt": "2026-09-04T10:15:00.000Z",
    "updatedAt": "2026-09-04T10:15:00.000Z"
  }
}
POST/registry/v1/packages/remove

Withdraw a package from discovery

Scope
registry:packages:remove Admin-issued keys only.

Request bodyapplication/json

Request body of removeRegistryPackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

Response 200The package was withdrawn

Response of removeRegistryPackage

  • datarequired
    Type
    object
    Description
  • protocolrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
  • removedrequired
    Type
    boolean
    Description
    one of true

Example

curl
curl -X POST https://api.rsx.group/registry/v1/packages/remove \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "protocol": "npm",
  "name": "@rsx/metal"
}'
200 response
{
  "data": {
    "protocol": "string",
    "name": "string",
    "removed": true
  }
}
07

versions

3 operations under /registry/v1/versions.

GET/registry/v1/versions/list

List a package's versions

Scope
registry:versions:list Admin-issued keys only.

Query parameters

Query parameters of listRegistryVersions

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • cursor
    Type
    string
    Description
  • limit
    Type
    integer
    Description
    1 to 100 · default 20

Response 200Versions

Response of listRegistryVersions

  • datarequired
    Type
    array of RegistryVersion
    Description
  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.
  • metarequired
    Type
    object
    Description
  • cursorrequired
    Type
    string, or null
    Description

Example

curl
curl "https://api.rsx.group/registry/v1/versions/list?protocol=npm&name=%40rsx%2Fmetal" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": [
    {
      "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d11",
      "protocol": "npm",
      "name": "@rsx/metal",
      "version": "0.6.0",
      "status": "published",
      "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 8419372,
      "artefacts": [
        {
          "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
          "platform": "linux-x86_64",
          "mediaType": "application/vnd.npm.install-v1+tgz",
          "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
          "size": 8419372,
          "stored": true,
          "createdAt": "2026-09-04T10:15:00.000Z"
        }
      ],
      "createdAt": "2026-09-04T10:15:00.000Z",
      "publishedAt": "2026-09-04T10:16:30.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}
GET/registry/v1/versions/get

Read one version

Scope
registry:versions:get Admin-issued keys only.

Query parameters

Query parameters of getRegistryVersion

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters

Response 200The version

Response of getRegistryVersion

  • datarequired
    Type
    RegistryVersion
    Description
  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.

Example

curl
curl "https://api.rsx.group/registry/v1/versions/get?protocol=npm&name=%40rsx%2Fmetal&version=0.6.0" \
  -H "Authorization: Bearer rsx_live_..."
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d11",
    "protocol": "npm",
    "name": "@rsx/metal",
    "version": "0.6.0",
    "status": "published",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 8419372,
    "artefacts": [
      {
        "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
        "platform": "linux-x86_64",
        "mediaType": "application/vnd.npm.install-v1+tgz",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 8419372,
        "stored": true,
        "createdAt": "2026-09-04T10:15:00.000Z"
      }
    ],
    "createdAt": "2026-09-04T10:15:00.000Z",
    "publishedAt": "2026-09-04T10:16:30.000Z"
  }
}
POST/registry/v1/versions/add

Declare a version and the artefacts it consists of

Scope
registry:versions:add Admin-issued keys only.
Idempotency
Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of addRegistryVersion

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • artefactsrequired
    Type
    array of RegistryArtefactDeclaration
    Description
    1 to 64 items
  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.
  • sizerequired
    Type
    integer
    Description
    Size of the artefact in bytes.at least 0

Response 200The declared version, staging until every artefact has arrived

Response of addRegistryVersion

  • datarequired
    Type
    RegistryVersion
    Description
  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.

Example

curl
curl -X POST https://api.rsx.group/registry/v1/versions/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "protocol": "npm",
  "name": "@rsx/metal",
  "version": "0.6.0",
  "artefacts": [
    {
      "platform": "linux-x86_64",
      "mediaType": "application/vnd.npm.install-v1+tgz",
      "digest": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "size": 8419372
    }
  ]
}'
200 response
{
  "data": {
    "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d11",
    "protocol": "npm",
    "name": "@rsx/metal",
    "version": "0.6.0",
    "status": "published",
    "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "size": 8419372,
    "artefacts": [
      {
        "id": "018f3b1c-9a2e-7c31-8f4d-2a6b5c7e9d10",
        "platform": "linux-x86_64",
        "mediaType": "application/vnd.npm.install-v1+tgz",
        "digest": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "size": 8419372,
        "stored": true,
        "createdAt": "2026-09-04T10:15:00.000Z"
      }
    ],
    "createdAt": "2026-09-04T10:15:00.000Z",
    "publishedAt": "2026-09-04T10:16:30.000Z"
  }
}
08

Schemas

Every named shape in this reference, as the operations above refer to it.

RegistryNativeFinding

RegistryNativeFinding

  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description

RegistryNativeManifest

RegistryNativeManifest

  • formatrequired
    Type
    integer
    Description
    1 to 3
  • descriptionrequired
    Type
    string
    Description
  • requiresrequired
    Type
    array of object
    Description
  • namerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
    * for any installed version, or =VERSION for exactly one.

RegistryNativeRelease

RegistryNativeRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • formatrequired
    Type
    integer
    Description
    1 to 3
  • descriptionrequired
    Type
    string
    Description
  • requiresrequired
    Type
    array of object
    Description
  • namerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
    * for any installed version, or =VERSION for exactly one.
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

RegistryNativeAdminRelease

RegistryNativeAdminRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • architecturerequired
    Type
    string
    Description
    The archive's declared architecture, as its manifest spells it.one of "x86_64", "any"
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string, or null
    Description
    The release's review state.one of "invalid", "pending", "approved", "rejected", "revoked"
  • findingsrequired
    Type
    array of RegistryNativeFinding
    Description
  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description
  • manifestrequired
    Type
    RegistryNativeManifest
    Description
  • formatrequired
    Type
    integer
    Description
    1 to 3
  • descriptionrequired
    Type
    string
    Description
  • requiresrequired
    Type
    array of object
    Description
  • namerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
    * for any installed version, or =VERSION for exactly one.
  • supersedesrequired
    Type
    array of string
    Description
  • isDefaultrequired
    Type
    boolean
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description

RegistryNativeReleaseUpdate

RegistryNativeReleaseUpdate

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reviewStaterequired
    Type
    string
    Description
    one of "approved", "rejected", "revoked"
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • supersedes
    Type
    array of string
    Description
    up to 32 items
  • revokeCode
    Type
    string
    Description
    Why a release was withdrawn from new installs.one of "security", "broken", "withdrawn"

RegistryNativePackageUpdate

RegistryNativePackageUpdate

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • defaultVersionrequired
    Type
    string, or null
    Description
    Package version, or an OCI tag.1 to 128 characters

RegistryNativeSnapshot

RegistryNativeSnapshot

  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

RegistryNativeSnapshotPreview

RegistryNativeSnapshotPreview

  • currentGenerationrequired
    Type
    integer, or null
    Description
  • addedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • architecturerequired
    Type
    string
    Description
  • removedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • architecturerequired
    Type
    string
    Description
  • revokedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • defaultsChangedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • fromrequired
    Type
    string, or null
    Description
  • torequired
    Type
    string, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • unchangedrequired
    Type
    boolean
    Description

RegistryNativeSnapshotPublish

RegistryNativeSnapshotPublish

  • expectGenerationrequired
    Type
    integer, or null
    Description

RegistryNativeKeysStatus

RegistryNativeKeysStatus

  • repositoryrequired
    Type
    string
    Description
  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

RegistryNativeKeysUpdate

RegistryNativeKeysUpdate

  • enveloperequired
    Type
    string
    Description
    1 to 65536 characters

RegistryAppApplication

RegistryAppApplication

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string, or null
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • pendingCountrequired
    Type
    integer
    Description
  • identitiesrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • identityrequired
    Type
    string
    Description
  • pinnedVersionrequired
    Type
    string
    Description
  • pinnedAtrequired
    Type
    string, date-time
    Description
  • updatedByrequired
    Type
    string, or null
    Description
  • updatedAtrequired
    Type
    string, date-time, or null
    Description

RegistryAppApplicationUpdate

RegistryAppApplicationUpdate

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • visibility
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • appId
    Type
    string
    Description
    up to 128 characters · matches ^[a-z][a-z0-9-]*(?:\.[a-z][a-z0-9-]*)+$
  • displayName
    Type
    string, or null
    Description
    1 to 80 characters
  • summary
    Type
    string, or null
    Description
    1 to 280 characters
  • homepageUrl
    Type
    string, uri, or null
    Description
    up to 512 characters
  • docsUrl
    Type
    string, uri, or null
    Description
    up to 512 characters

RegistryAppFinding

RegistryAppFinding

  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description

RegistryAppAsset

RegistryAppAsset

  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • uploadedrequired
    Type
    boolean
    Description
  • outcomerequired
    Type
    string, or null
    Description
    one of "valid", "invalid"
  • findingsrequired
    Type
    array of RegistryAppFinding
    Description
  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description
  • notesrequired
    Type
    array of RegistryAppFinding
    Description
  • checkrequired
    Type
    string
    Description
  • messagerequired
    Type
    string
    Description
  • identityrequired
    Type
    string, or null
    Description
  • factsrequired
    Type
    map of one of string, number, boolean, any, or null, any, or null
    Description
  • {key}
    Type
    one of string, number, boolean, any, or null, any, or null
    Description

RegistryAppRequirement

RegistryAppRequirement

  • minOsVersion
    Type
    string, or null
    Description
    1 to 64 characters · matches ^[0-9A-Za-z][0-9A-Za-z._-]*$
  • notes
    Type
    string, or null
    Description
    up to 500 characters

RegistryAppRelease

RegistryAppRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • uploadedrequired
    Type
    boolean
    Description
  • outcomerequired
    Type
    string, or null
    Description
    one of "valid", "invalid"
  • findingsrequired
    Type
    array of RegistryAppFinding
    Description
  • notesrequired
    Type
    array of RegistryAppFinding
    Description
  • identityrequired
    Type
    string, or null
    Description
  • factsrequired
    Type
    map of one of string, number, boolean, any, or null, any, or null
    Description
  • {key}
    Type
    one of string, number, boolean, any, or null, any, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description

RegistryAppAdminRelease

RegistryAppAdminRelease

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • uploadedrequired
    Type
    boolean
    Description
  • outcomerequired
    Type
    string, or null
    Description
    one of "valid", "invalid"
  • findingsrequired
    Type
    array of RegistryAppFinding
    Description
  • notesrequired
    Type
    array of RegistryAppFinding
    Description
  • identityrequired
    Type
    string, or null
    Description
  • factsrequired
    Type
    map of one of string, number, boolean, any, or null, any, or null
    Description
  • {key}
    Type
    one of string, number, boolean, any, or null, any, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description

RegistryAppReleaseDecision

RegistryAppReleaseDecision

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    one of "staging", "published"
  • reviewStaterequired
    Type
    string
    Description
    one of "staging", "invalid", "pending", "approved", "rejected", "revoked"
  • assetsrequired
    Type
    array of RegistryAppAsset
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • uploadedrequired
    Type
    boolean
    Description
  • outcomerequired
    Type
    string, or null
    Description
    one of "valid", "invalid"
  • findingsrequired
    Type
    array of RegistryAppFinding
    Description
  • notesrequired
    Type
    array of RegistryAppFinding
    Description
  • identityrequired
    Type
    string, or null
    Description
  • factsrequired
    Type
    map of one of string, number, boolean, any, or null, any, or null
    Description
  • {key}
    Type
    one of string, number, boolean, any, or null, any, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • requirementsrequired
    Type
    map of RegistryAppRequirement
    Description
  • {key}
    Type
    RegistryAppRequirement
    Description
  • channelsrequired
    Type
    array of string
    Description
  • reviewReasonrequired
    Type
    string, or null
    Description
  • reviewedAtrequired
    Type
    string, date-time, or null
    Description
  • revokeCoderequired
    Type
    string, or null
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • revokeReasonrequired
    Type
    string, or null
    Description
  • revokedAtrequired
    Type
    string, date-time, or null
    Description
  • firstGenerationrequired
    Type
    integer, or null
    Description
  • visibilityrequired
    Type
    string
    Description
    internal (staff tooling, key-only repository) or public (the public repository).one of "internal", "public"
  • reviewedByrequired
    Type
    string, or null
    Description
  • revokedByrequired
    Type
    string, or null
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publicationrequired
    Type
    one of object, object, any, or null
    Description

RegistryAppReleaseUpdate

RegistryAppReleaseUpdate

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reviewStaterequired
    Type
    string
    Description
    one of "approved", "rejected", "revoked"
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • revokeCode
    Type
    string
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"

RegistryAppChannelUpdate

RegistryAppChannelUpdate

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • channelrequired
    Type
    string
    Description
    one of "stable", "beta", "canary"
  • versionrequired
    Type
    string, or null
    Description
    Package version, or an OCI tag.1 to 128 characters
  • reasonrequired
    Type
    string
    Description
    1 to 160 characters · matches ^[\x20-\x7e]+$
  • allowDowngrade
    Type
    boolean
    Description

RegistryAppSnapshot

RegistryAppSnapshot

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • generationrequired
    Type
    integer
    Description
  • staterequired
    Type
    string
    Description
    one of "writing", "current", "superseded", "abandoned"
  • kindrequired
    Type
    string
    Description
    one of "publish", "refresh"
  • keysVersionrequired
    Type
    integer
    Description
  • keyIdrequired
    Type
    string
    Description
  • signedAtrequired
    Type
    string, date-time
    Description
  • expiresAtrequired
    Type
    string, date-time
    Description
  • payloadSha256required
    Type
    string, or null
    Description
  • sizerequired
    Type
    integer, or null
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • publishedByrequired
    Type
    string
    Description

RegistryAppSnapshotPreview

RegistryAppSnapshotPreview

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • currentGenerationrequired
    Type
    integer, or null
    Description
  • addedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • removedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • revokedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • versionrequired
    Type
    string
    Description
  • channelsChangedrequired
    Type
    array of object
    Description
  • packagerequired
    Type
    string
    Description
  • channelrequired
    Type
    string
    Description
  • fromrequired
    Type
    string, or null
    Description
  • torequired
    Type
    string, or null
    Description
  • applicationCountrequired
    Type
    integer
    Description
  • releaseCountrequired
    Type
    integer
    Description
  • unchangedrequired
    Type
    boolean
    Description

RegistryAppSnapshotPublish

RegistryAppSnapshotPublish

  • repositoryrequired
    Type
    string
    Description
    one of "public", "internal"
  • expectGenerationrequired
    Type
    integer, or null
    Description
    at least 1

RegistryAppKeysStatus

RegistryAppKeysStatus

  • rootKeyIdsrequired
    Type
    array of string
    Description
  • keysVersionrequired
    Type
    integer, or null
    Description
  • expiresAtrequired
    Type
    string, date-time, or null
    Description
  • onlineKeyIdsrequired
    Type
    array of string
    Description
  • signingKeyIdrequired
    Type
    string, or null
    Description
  • signingKeyListedrequired
    Type
    boolean
    Description

RegistryAppKeysUpdate

RegistryAppKeysUpdate

  • enveloperequired
    Type
    string
    Description
    1 to 65536 characters

RegistryCatalogueApplication

RegistryCatalogueApplication

  • namerequired
    Type
    string
    Description
  • appIdrequired
    Type
    string, or null
    Description
  • displayNamerequired
    Type
    string
    Description
  • summaryrequired
    Type
    string, or null
    Description
  • homepageUrlrequired
    Type
    string, or null
    Description
  • docsUrlrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    map of string
    Description
  • {key}
    Type
    string
    Description
  • platformsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description

RegistryCatalogueRelease

RegistryCatalogueRelease

  • versionrequired
    Type
    string
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
  • notesrequired
    Type
    string, or null
    Description
  • channelsrequired
    Type
    array of string
    Description
  • revokedrequired
    Type
    object, or null
    Description
  • coderequired
    Type
    string
    Description
    Why a release was withdrawn.one of "security", "broken", "withdrawn"
  • reasonrequired
    Type
    string
    Description
  • revokedAtrequired
    Type
    string, date-time
    Description
  • assetsrequired
    Type
    array of object
    Description
  • platformrequired
    Type
    string
    Description
    Platform key: operating system, architecture and installer format.one of "windows-x86_64-msix", "windows-x86_64-exe", "debian-amd64-deb", "android-arm64-v8a-apk"
  • osrequired
    Type
    string
    Description
  • archrequired
    Type
    string
    Description
  • formatrequired
    Type
    string
    Description
  • labelrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • sha256required
    Type
    string
    Description
  • minOsVersionrequired
    Type
    string, or null
    Description
  • requirementNotesrequired
    Type
    string, or null
    Description
  • identityrequired
    Type
    string, or null
    Description
  • filenamerequired
    Type
    string
    Description
  • downloadUrlrequired
    Type
    string, or null
    Description
  • signedInrequired
    Type
    object, or null
    Description
  • generationrequired
    Type
    integer
    Description
  • snapshotUrlrequired
    Type
    string
    Description

RegistryPackage

RegistryPackage

  • idrequired
    Type
    string
    Description
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • scoperequired
    Type
    string, or null
    Description
    npm scope the package belongs to, where it has one.
  • visibilityrequired
    Type
    string
    Description
    Who may consume the package. Every v1 package is internal.one of "internal"
  • ownerrequired
    Type
    string
    Description
    The RSX principal that owns the package.1 to 128 characters
  • descriptionrequired
    Type
    string, or null
    Description
    What the package is, shown wherever the registry is browsed.
  • latestrequired
    Type
    string, or null
    Description
    Highest published version, or null when nothing is published yet.
  • versionCountrequired
    Type
    integer
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • updatedAtrequired
    Type
    string, date-time
    Description

RegistryArtefact

RegistryArtefact

  • idrequired
    Type
    string
    Description
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest, as stored.
  • sizerequired
    Type
    integer
    Description
  • storedrequired
    Type
    boolean
    Description
    Whether the bytes have arrived and matched the declared digest.
  • createdAtrequired
    Type
    string, date-time
    Description

RegistryVersion

RegistryVersion

  • idrequired
    Type
    string
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • statusrequired
    Type
    string
    Description
    Whether every declared artefact has arrived and been verified.one of "staging", "published"
  • digestrequired
    Type
    string, or null
    Description
    Digest of the release's primary artefact.
  • sizerequired
    Type
    integer, or null
    Description
    Total size of the release's artefacts in bytes.
  • artefactsrequired
    Type
    array of RegistryArtefact
    Description
  • idrequired
    Type
    string
    Description
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest, as stored.
  • sizerequired
    Type
    integer
    Description
  • storedrequired
    Type
    boolean
    Description
    Whether the bytes have arrived and matched the declared digest.
  • createdAtrequired
    Type
    string, date-time
    Description
  • createdAtrequired
    Type
    string, date-time
    Description
  • publishedAtrequired
    Type
    string, date-time, or null
    Description
    When the last declared artefact arrived. Null while publication is incomplete.

RegistryResolvedManifest

RegistryResolvedManifest

  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • referencerequired
    Type
    string
    Description
  • digestrequired
    Type
    string
    Description
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • sizerequired
    Type
    integer
    Description
  • imagerequired
    Type
    string
    Description

RegistryBinaryArtefact

RegistryBinaryArtefact

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • platformrequired
    Type
    string, or null
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
  • sizerequired
    Type
    integer
    Description
  • downloadrequired
    Type
    string
    Description
    Path to fetch the bytes from, using the same API key.

RegistryAuditEvent

RegistryAuditEvent

  • idrequired
    Type
    string
    Description
  • actorrequired
    Type
    string
    Description
  • actionrequired
    Type
    string
    Description
    Dotted and past tense, matching the platform's other trails.1 to 64 characters
  • targetTyperequired
    Type
    string
    Description
    What the event was about.one of "package", "version", "snapshot", "keys"
  • targetIdrequired
    Type
    string
    Description
  • targetLabelrequired
    Type
    string, or null
    Description
  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • atrequired
    Type
    string, date-time
    Description
  • detailrequired
    Type
    string, or null
    Description

RegistryAppReleaseDetails

RegistryAppReleaseDetails

  • packagerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • notes
    Type
    string, or null
    Description
    up to 20000 characters
  • requirements
    Type
    object
    Description
  • windows-x86_64-msix
    Type
    RegistryAppRequirement
    Description
  • windows-x86_64-exe
    Type
    RegistryAppRequirement
    Description
  • debian-amd64-deb
    Type
    RegistryAppRequirement
    Description
  • android-arm64-v8a-apk
    Type
    RegistryAppRequirement
    Description

RegistryAddPackage

RegistryAddPackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • description
    Type
    string
    Description
    up to 512 characters

RegistryUpdatePackage

RegistryUpdatePackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • description
    Type
    string, or null
    Description
    up to 512 characters
  • owner
    Type
    string
    Description
    Transfer ownership. The current owner only.1 to 128 characters

RegistryRemovePackage

RegistryRemovePackage

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters

RegistryArtefactDeclaration

RegistryArtefactDeclaration

  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.
  • sizerequired
    Type
    integer
    Description
    Size of the artefact in bytes.at least 0

RegistryAddVersion

RegistryAddVersion

  • protocolrequired
    Type
    string
    Description
    Distribution protocol the package is published under.one of "npm", "cargo", "binary", "oci", "native", "app"
  • namerequired
    Type
    string
    Description
    Package name, in the naming rules of its own ecosystem.1 to 255 characters
  • versionrequired
    Type
    string
    Description
    Package version, or an OCI tag.1 to 128 characters
  • artefactsrequired
    Type
    array of RegistryArtefactDeclaration
    Description
    1 to 64 items
  • platform
    Type
    string
    Description
    Platform identifier, for a release that ships more than one artefact.1 to 64 characters · matches ^[a-z0-9][a-z0-9._-]*$
  • mediaTyperequired
    Type
    string
    Description
    Media type of the stored bytes.1 to 255 characters
  • digestrequired
    Type
    string
    Description
    SHA-256 content digest of the artefact bytes.
  • sizerequired
    Type
    integer
    Description
    Size of the artefact in bytes.at least 0