ProductsSupportPartnersDocumentation

Application Packages

List

get

Retrieve application package(s).

Query parameters
siteIdinteger · int32Optional

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

NamestringOptional

Application package name (optional).

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AppPackage HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-07-08T09:01:31.702Z",
    "timeLastMod": "2025-07-08T09:01:31.702Z",
    "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": "2025-07-08T09:01:31.702Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    },
    "siteId": 1,
    "enabled": true,
    "tagIds": [
      1
    ]
  }
]

Create

post

Create a new application package.

Body

To create a new Application Package

displayNamestring | nullableOptional

Display name of the new application package.

packageNamestring | nullableRequired

Package name of the new application package.

msixImagePathstring | nullableRequired

MSIX image path of the new application package.

Responses
201
Created
application/json; api-version=1.0
post
POST /api/AppPackage HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66

{
  "displayName": "text",
  "packageName": "text",
  "msixImagePath": "text"
}
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-08T09:01:31.702Z",
  "timeLastMod": "2025-07-08T09:01:31.702Z",
  "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": "2025-07-08T09:01:31.702Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "siteId": 1,
  "enabled": true,
  "tagIds": [
    1
  ]
}

Get

get

Retrieve an application package by ID.

Path parameters
idinteger · int32Required

Application package ID.

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AppPackage/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-08T09:01:31.702Z",
  "timeLastMod": "2025-07-08T09:01:31.702Z",
  "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": "2025-07-08T09:01:31.702Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "siteId": 1,
  "enabled": true,
  "tagIds": [
    1
  ]
}

Update

put

Update application package settings.

Path parameters
idinteger · int32Required

Application package ID.

Body

Modify an Application Package

enabledboolean | nullableOptional

Enable or disable the application package.

displayNamestring | nullableOptional

The new display name of the application package.

tagId1boolean | nullableOptional

Enable or disable Tag with Id 1.

tagId2boolean | nullableOptional

Enable or disable Tag with Id 2.

tagId3boolean | nullableOptional

Enable or disable Tag with Id 3.

Responses
204
No Content
put
PUT /api/AppPackage/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 79

{
  "enabled": true,
  "displayName": "text",
  "tagId1": true,
  "tagId2": true,
  "tagId3": true
}
No content

Delete

delete

Delete an application package.

Path parameters
idinteger · int32Required

Application package ID.

Responses
204
No Content
delete
DELETE /api/AppPackage/{id} HTTP/1.1
Host: 
Accept: */*

No content
PreviousRDSNextMSIX Image

Was this helpful?