Application Packages

PreviousRDS NextMSIX Image

Was this helpful?

Get

get

Retrieve an application package by ID.

Path parameters

idinteger · int32required

Application package ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AppPackage/{id}'

200

401

404

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

Success

Delete

delete

Delete an application package.

Path parameters

idinteger · int32required

Application package ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AppPackage/{id}'

204

401

404

No Content

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AppPackage'

200

401

404

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

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AppPackage' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "displayName": "text",
    "packageName": "text",
    "msixImagePath": "text"
  }'

201

401

409

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

Created

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AppPackage/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "displayName": "text",
    "tagId1": true,
    "tagId2": true,
    "tagId3": true
  }'

204

401

404

No Content