1 of 3

Application Packages

MSIX Image

Details

List Details

Retrieve the list of package details from an image.

GET/api/MSIXImage/Details

Query parameters

Pathstring

The MSIX image path (URL encoded in ASCII format).

Response

Success

Body

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

Request

Response

List Details

Retrieve the list of package details from an image.

GET/api/MSIXImage/Details

Query parameters

Pathstring

The MSIX image path (URL encoded in ASCII format).

Response

Success

Body

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

Request

Response

const response = await fetch('/api/MSIXImage/Details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "packageName": "text",
    "displayName": "text",
    "version": "text",
    "publisher": "text",
    "msixImagePath": "text",
    "packagedApps": [
      {
        "name": "text"
      }
    ],
    "dependencies": "text",
    "certificate": {
      "status": [
        "0 = Valid",
        "1 = Expiring",
        "2 = Expired",
        "3 = InProgress",
        "4 = Revoked",
        "5 = Issuing",
        "6 = IssuingFailed",
        "7 = Renewing",
        "8 = RenewingFailed",
        "9 = Revoking",
        "10 = RevokingFailed"
      ],
      "publicKey": "text",
      "expirationDate": "2024-11-07T10:06:37.234Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    }
  }
]

Application Packages

List

Retrieve application package(s).

GET/api/AppPackage

Query parameters

siteIdinteger (int32)

ID of the SIte from which to retrieve the AppPackage setting.(optional).

Namestring

Application package name (optional).

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

Create

Create a new application package.

POST/api/AppPackage

Body

Application package settings.

displayNamenullable string

Display name of the new application package.

packageName*nullable string

Package name of the new application package.

msixImagePath*nullable string

MSIX image path of the new application package.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

Get

Retrieve an application package by ID.

GET/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

Update

Update application package settings.

PUT/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Body

Application package settings.

enablednullable boolean

Enable or disable the application package.

displayNamenullable string

The new display name of the application package.

tagId1nullable boolean

Enable or disable Tag with Id 1.

tagId2nullable boolean

Enable or disable Tag with Id 2.

tagId3nullable boolean

Enable or disable Tag with Id 3.

Response

No Content

Request

Response

Delete

Delete an application package.

DELETE/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

No Content

Request

Response

Delete

Delete an application package.

DELETE/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

No Content

Request

Response

Update

Update application package settings.

PUT/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Body

Application package settings.

enablednullable boolean

Enable or disable the application package.

displayNamenullable string

The new display name of the application package.

tagId1nullable boolean

Enable or disable Tag with Id 1.

tagId2nullable boolean

Enable or disable Tag with Id 2.

tagId3nullable boolean

Enable or disable Tag with Id 3.

Response

No Content

Request

Response

Get

Retrieve an application package by ID.

GET/api/AppPackage/{id}

Path parameters

id*integer (int32)

Application package ID.

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

Create

Create a new application package.

POST/api/AppPackage

Body

Application package settings.

displayNamenullable string

Display name of the new application package.

packageName*nullable string

Package name of the new application package.

msixImagePath*nullable string

MSIX image path of the new application package.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

List

Retrieve application package(s).

GET/api/AppPackage

Query parameters

siteIdinteger (int32)

ID of the SIte from which to retrieve the AppPackage setting.(optional).

Namestring

Application package name (optional).

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

packageNamenullable string

Package name

displayNamenullable string

Application package display name

versionnullable string

Application package version

publishernullable string

Application package publisher name

msixImagePathnullable string

MSIX image path

packagedAppsnullable array of PackagedApp (object)

List of applications in the application package

namenullable string

Application name in the application package

dependenciesnullable string

Application pacakge dependencies

certificateAppPackageCertificate (object)

Application Package Certificate

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

commonNamenullable string

The common name of the certificate.

siteIdinteger (int32)

ID of the Site

enabledboolean

Whether the application package is enabled or not

tagIdsnullable array of integer (int32)

Application tag IDs

itemsinteger (int32)

Request

Response

const response = await fetch('/api/AppPackage/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/AppPackage/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/AppPackage/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:06:37.337Z",
  "timeLastMod": "2024-11-07T10:06:37.337Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2024-11-07T10:06:37.337Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "enabled": false,
  "tagIds": []
}

const response = await fetch('/api/AppPackage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "msixImagePath": "text",
      "packageName": "text"
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:06:37.337Z",
  "timeLastMod": "2024-11-07T10:06:37.337Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2024-11-07T10:06:37.337Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "enabled": false,
  "tagIds": []
}

const response = await fetch('/api/AppPackage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:06:37.337Z",
    "timeLastMod": "2024-11-07T10:06:37.337Z",
    "packageName": "text",
    "displayName": "text",
    "version": "text",
    "publisher": "text",
    "msixImagePath": "text",
    "packagedApps": [
      {
        "name": "text"
      }
    ],
    "dependencies": "text",
    "certificate": {
      "status": [
        "0 = Valid",
        "1 = Expiring",
        "2 = Expired",
        "3 = InProgress",
        "4 = Revoked",
        "5 = Issuing",
        "6 = IssuingFailed",
        "7 = Renewing",
        "8 = RenewingFailed",
        "9 = Revoking",
        "10 = RevokingFailed"
      ],
      "publicKey": "text",
      "expirationDate": "2024-11-07T10:06:37.337Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    },
    "enabled": false,
    "tagIds": []
  }
]