Deployment

Operations related to project deployments.

Get organizations project deployments

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments

Get organizations project deployments by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

Current page number

Default: 1

sortstringOptional

Sort

Example: {"value":"createdAt"}

deploymentTypestring · enumOptional

Deployment type

Possible values:

isLivebooleanOptional

The is live to filter

isOnStorestring · enumOptional

The is on store to filter

Possible values:

statusstringOptional

Status

osstring · enumOptional

Os

Possible values:

buildTargetstring · enumOptional

Build target

Possible values:

forceUpdatebooleanOptional

The force update to filter

envVersionstringOptional

Env version

storeVersionstringOptional

Store version

parentstringOptional

Parent

createdBystringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

createdAtstringOptional

Created at date

Responses

200

OK

application/json

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/deployments HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 1,
  "limit": 10,
  "page": 1,
  "totalPages": 1,
  "pagingCounter": 1,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 1,
  "docs": [
    {
      "_id": "text",
      "project": {
        "_id": "text",
        "name": "text",
        "slug": "text",
        "description": "text",
        "organization": "text",
        "credential": {},
        "additionalCredentials": {},
        "storeCredentials": {
          "googlePlay": {
            "googleServiceFile": "text",
            "packageName": "text"
          },
          "appleAppStore": {
            "keyId": "ABCDEFGHIJ",
            "keyIssuerId": "12345678-1234-1234-1234-123456789012",
            "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
            "keyInHouse": true,
            "appIdentifier": "com.akinon.test",
            "teamId": "ABCDEFGHIJ",
            "teamName": "Akinon Team",
            "appSpecificId": 1234567890
          },
          "huaweiAppGallery": {
            "clientId": "text",
            "clientSecret": "text"
          }
        },
        "appStatuses": {
          "android": {
            "production": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text",
              "versionCode": 1
            },
            "staging": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text",
              "versionCode": 1
            }
          },
          "huawei": {
            "production": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text",
              "versionCode": 1
            },
            "staging": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text",
              "versionCode": 1
            }
          },
          "ios": {
            "production": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text"
            },
            "staging": {
              "createdAt": "text",
              "deploymentId": "text",
              "envVersion": "text",
              "publishedAt": "text",
              "publisher": "text",
              "status": true,
              "storeVersion": "text",
              "tag": "text",
              "updatedAt": "text"
            }
          }
        },
        "status": "draft",
        "lastActivityAt": "2026-03-09T20:33:39.284Z",
        "appIconUrl": "text",
        "createdAt": "2026-03-09T20:33:39.284Z",
        "updatedAt": "2026-03-09T20:33:39.284Z"
      },
      "user": {
        "_id": "text",
        "username": "text",
        "language": "text",
        "region": "text",
        "firstName": "text",
        "lastName": "text",
        "status": 0,
        "attributes": {},
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2026-03-09T20:33:39.284Z",
        "createdAt": "2026-03-09T20:33:39.284Z",
        "updatedAt": "2026-03-09T20:33:39.284Z"
      },
      "parent": "text",
      "description": "text",
      "status": "pending",
      "os": "android",
      "buildTarget": "staging",
      "deploymentType": "build",
      "stages": [
        {
          "_id": "63ea10b94a472e003305232b",
          "name": "text",
          "createdAt": "2026-03-09T20:33:39.284Z",
          "updatedAt": "2026-03-09T20:33:39.284Z"
        }
      ],
      "startedAt": "2026-03-09T20:33:39.284Z",
      "completedAt": "2026-03-09T20:33:39.284Z",
      "abolisher": "text",
      "forceUpdate": false,
      "tag": "text",
      "checksum": "text",
      "size": 1,
      "uploadDuration": 1,
      "downloadUrl": "text",
      "remoteId": 1,
      "plugins": [
        {
          "name": "text",
          "version": "text",
          "moduleName": "text"
        }
      ],
      "issues": [
        {
          "type": "error",
          "message": "text"
        }
      ],
      "timeline": [
        {
          "step": 1,
          "startTime": "2026-03-09T20:33:39.284Z",
          "finishTime": "2026-03-09T20:33:39.284Z",
          "error": "text"
        }
      ],
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z",
      "versionCode": 1,
      "javaVersion": "text",
      "xcodeVersion": "text",
      "extensions": [
        "com.akinon.fashfed.RelatedDigitalNotificationExtension",
        "com.akinon.fashfed.RelatedDigitalNotificationContent"
      ],
      "envVersion": "text",
      "storeVersion": "text",
      "isLive": true,
      "isOnStore": null
    }
  ]
}

Get a organization project deployment

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

Get a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

or

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "versionCode": 1,
  "javaVersion": "text",
  "xcodeVersion": "text",
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "text",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": null
}

Cancel a organization project deployment

patch

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel

Cancel a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

or

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel

HTTPcURLJavaScriptPython

PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "versionCode": 1,
  "javaVersion": "text",
  "xcodeVersion": "text",
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "text",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": null
}

Update deployment store state

patch

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/storestate

Update deployment store state by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

isOnStorestring · enumRequiredPossible values:

Responses

200

OK

application/json

or

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/storestate

HTTPcURLJavaScriptPython

PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/storestate HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "isOnStore": "pending"
}

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "versionCode": 1,
  "javaVersion": "text",
  "xcodeVersion": "text",
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "text",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": null
}

Get a organization project deployment metrics

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/metrics

Get a organization project deployment metrics by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

activenumberOptional

Active count

installednumberOptional

Installed count

downloadednumberOptional

Downloaded count

failednumberOptional

Failed count

labelstringOptional

Label

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/metrics

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/metrics HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "active": 1,
    "installed": 1,
    "downloaded": 0,
    "failed": 0,
    "label": "1.0.29"
  }
]

Update a organization project deployment release

patch

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/code-push-release

Update a organization project deployment release by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

Responses

200

OK

application/json

or

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/code-push-release

HTTPcURLJavaScriptPython

PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/code-push-release HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "release": {
    "targetBinaryRange": "<targetBinaryRange>",
    "description": "<description>",
    "isDisabled": "<isDisabled>",
    "isMandatory": "<isMandatory>",
    "rollout": "<rollout>"
  }
}

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "versionCode": 1,
  "javaVersion": "text",
  "xcodeVersion": "text",
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "text",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": null
}

Rollback a organization project deployment code push

post

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/rollback-release

Rollback a organization project deployment code push by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

releaseLabelstringRequired

Code push label

Example: <releaseLabel>

Responses

200

OK

application/json

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/rollback-release

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/rollback-release HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "releaseLabel": "<releaseLabel>"
}

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "code-push",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "targetBinaryRange": "text",
  "label": "text",
  "originalLabel": "text",
  "isMandatory": false,
  "isDisabled": false,
  "rollout": 100,
  "releaseMethod": "upload"
}

Promote a organization project deployment code push

post

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release

Promote a organization project deployment code push by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "project": {
    "_id": "text",
    "name": "text",
    "slug": "text",
    "description": "text",
    "organization": "text",
    "credential": {},
    "additionalCredentials": {},
    "storeCredentials": {
      "googlePlay": {
        "googleServiceFile": "text",
        "packageName": "text"
      },
      "appleAppStore": {
        "keyId": "ABCDEFGHIJ",
        "keyIssuerId": "12345678-1234-1234-1234-123456789012",
        "apiKeyFile": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/b12ba00a-13ff-4e70-a2fc-41065b9d1e9d_b058caad-b7ba-4700-bb17-040206abb111_86851bc2-d08f-488c-9956-86ef6c7d5fc2_Akinon_shop_prod-(2)-(1).p8",
        "keyInHouse": true,
        "appIdentifier": "com.akinon.test",
        "teamId": "ABCDEFGHIJ",
        "teamName": "Akinon Team",
        "appSpecificId": 1234567890
      },
      "huaweiAppGallery": {
        "clientId": "text",
        "clientSecret": "text"
      }
    },
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "huawei": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text",
          "versionCode": 1
        }
      },
      "ios": {
        "production": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        },
        "staging": {
          "createdAt": "text",
          "deploymentId": "text",
          "envVersion": "text",
          "publishedAt": "text",
          "publisher": "text",
          "status": true,
          "storeVersion": "text",
          "tag": "text",
          "updatedAt": "text"
        }
      }
    },
    "status": "draft",
    "lastActivityAt": "2026-03-09T20:33:39.284Z",
    "appIconUrl": "text",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "user": {
    "_id": "text",
    "username": "text",
    "language": "text",
    "region": "text",
    "firstName": "text",
    "lastName": "text",
    "status": 0,
    "attributes": {},
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2026-03-09T20:33:39.284Z",
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  },
  "parent": "text",
  "description": "text",
  "status": "pending",
  "os": "android",
  "buildTarget": "staging",
  "deploymentType": "code-push",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2026-03-09T20:33:39.284Z",
      "updatedAt": "2026-03-09T20:33:39.284Z"
    }
  ],
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "abolisher": "text",
  "forceUpdate": false,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "downloadUrl": "text",
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2026-03-09T20:33:39.284Z",
      "finishTime": "2026-03-09T20:33:39.284Z",
      "error": "text"
    }
  ],
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z",
  "targetBinaryRange": "text",
  "label": "text",
  "originalLabel": "text",
  "isMandatory": false,
  "isDisabled": false,
  "rollout": 100,
  "releaseMethod": "upload"
}

Get a organization project deployment distributions

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Get a organization project deployment distributions by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

_idstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

typestring · enumRequired

Distribution type; APPLE_APP_STORE 1, GOOGLE_PLAY 2, HUAWEI_APP_GALLERY 3

Possible values:

deploymentIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

userIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

abolisherIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

releaseNotesstringRequired

Release notes

statusstring · enumOptionalPossible values:

startedAtstring · date-timeRead-onlyOptional

Date

completedAtstring · date-timeRead-onlyOptional

Date

remoteIdstringRequired

Remote ID

Example: 1234567890

releaseMethodstring · enumOptional

Release method

Possible values:

trackstring · enumOptional

Distribution track

Possible values:

uploadMetadatabooleanOptional

Deployment upload metadata

Default: false

uploadScreenshotsbooleanOptional

Deployment upload screenshots

Default: false

shouldSubmitForReviewbooleanOptional

Deployment should submit for review

Default: false

shouldAutoReleasebooleanOptional

Deployment should auto release

Default: false

userFractionnumber · max: 1Optional

Deployment user fraction

Default: 1

updatePrioritynumber · max: 5Optional

Deployment update priority

Default: 0

createdAtstring · date-timeRead-onlyOptional

Date

updatedAtstring · date-timeRead-onlyOptional

Date

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63ea10b94a472e003305232b",
    "type": 1,
    "deploymentId": "text",
    "projectId": "text",
    "userId": "text",
    "abolisherId": "text",
    "releaseNotes": "text",
    "status": "pending",
    "startedAt": "2026-03-09T20:33:39.284Z",
    "completedAt": "2026-03-09T20:33:39.284Z",
    "remoteId": 1234567890,
    "releaseMethod": "upload",
    "track": "TestFlight",
    "uploadMetadata": false,
    "uploadScreenshots": false,
    "shouldSubmitForReview": false,
    "shouldAutoRelease": false,
    "userFraction": 1,
    "updatePriority": 0,
    "createdAt": "2026-03-09T20:33:39.284Z",
    "updatedAt": "2026-03-09T20:33:39.284Z"
  }
]

Create a organization project deployment distribution

post

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

Create a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

releaseNotesstringRequired

Deployment release notes

Example: <releaseNotes>

releaseMethodstring · enumOptional

Deployment release method

Possible values:

trackstring · enumRequired

Deployment track

Possible values:

uploadMetadatabooleanOptional

Deployment upload metadata

Default: falseExample: <uploadMetadata>

uploadScreenshotsbooleanOptional

Deployment upload screenshots

Default: falseExample: <uploadScreenshots>

shouldSubmitForReviewbooleanOptional

Deployment should submit for review

Default: falseExample: <shouldSubmitForReview>

shouldAutoReleasebooleanOptional

Deployment should auto release

Default: falseExample: <shouldAutoRelease>

userFractionnumber · max: 1Optional

Deployment user fraction

Default: 1Example: <userFraction>

updatePrioritynumber · max: 5Optional

Deployment update priority

Default: 0Example: <updatePriority>

Responses

201

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "releaseNotes": "<releaseNotes>",
  "releaseMethod": "upload",
  "track": "TestFlight",
  "uploadMetadata": "<uploadMetadata>",
  "uploadScreenshots": "<uploadScreenshots>",
  "shouldSubmitForReview": "<shouldSubmitForReview>",
  "shouldAutoRelease": "<shouldAutoRelease>",
  "userFraction": "<userFraction>",
  "updatePriority": "<updatePriority>"
}

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "deploymentId": "text",
  "projectId": "text",
  "userId": "text",
  "abolisherId": "text",
  "releaseNotes": "text",
  "status": "pending",
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "TestFlight",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z"
}

Get a organization project deployment distribution

get

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Get a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

distributionIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Responses

200

OK

application/json

_idstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

typestring · enumRequired

Distribution type; APPLE_APP_STORE 1, GOOGLE_PLAY 2, HUAWEI_APP_GALLERY 3

Possible values:

deploymentIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

userIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

abolisherIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

releaseNotesstringRequired

Release notes

statusstring · enumOptionalPossible values:

startedAtstring · date-timeRead-onlyOptional

Date

completedAtstring · date-timeRead-onlyOptional

Date

remoteIdstringRequired

Remote ID

Example: 1234567890

releaseMethodstring · enumOptional

Release method

Possible values:

trackstring · enumOptional

Distribution track

Possible values:

uploadMetadatabooleanOptional

Deployment upload metadata

Default: false

uploadScreenshotsbooleanOptional

Deployment upload screenshots

Default: false

shouldSubmitForReviewbooleanOptional

Deployment should submit for review

Default: false

shouldAutoReleasebooleanOptional

Deployment should auto release

Default: false

userFractionnumber · max: 1Optional

Deployment user fraction

Default: 1

updatePrioritynumber · max: 5Optional

Deployment update priority

Default: 0

createdAtstring · date-timeRead-onlyOptional

Date

updatedAtstring · date-timeRead-onlyOptional

Date

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "deploymentId": "text",
  "projectId": "text",
  "userId": "text",
  "abolisherId": "text",
  "releaseNotes": "text",
  "status": "pending",
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "TestFlight",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z"
}

Update a organization project deployment distribution

patch

https://abp-api.akinon.net/api/v1https://abptest-api.akinon.net/api/v1http://localhost:5001/api/v1

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

Update a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

deploymentIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

distributionIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

statusstring · enumOptional

Deployment status

Possible values:

remoteIdnumberOptional

Deployment remote id

Example: <remoteId>

Responses

200

OK

application/json

_idstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$

typestring · enumRequired

Distribution type; APPLE_APP_STORE 1, GOOGLE_PLAY 2, HUAWEI_APP_GALLERY 3

Possible values:

deploymentIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

projectIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

userIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

abolisherIdstringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$

releaseNotesstringRequired

Release notes

statusstring · enumOptionalPossible values:

startedAtstring · date-timeRead-onlyOptional

Date

completedAtstring · date-timeRead-onlyOptional

Date

remoteIdstringRequired

Remote ID

Example: 1234567890

releaseMethodstring · enumOptional

Release method

Possible values:

trackstring · enumOptional

Distribution track

Possible values:

uploadMetadatabooleanOptional

Deployment upload metadata

Default: false

uploadScreenshotsbooleanOptional

Deployment upload screenshots

Default: false

shouldSubmitForReviewbooleanOptional

Deployment should submit for review

Default: false

shouldAutoReleasebooleanOptional

Deployment should auto release

Default: false

userFractionnumber · max: 1Optional

Deployment user fraction

Default: 1

updatePrioritynumber · max: 5Optional

Deployment update priority

Default: 0

createdAtstring · date-timeRead-onlyOptional

Date

updatedAtstring · date-timeRead-onlyOptional

Date

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId}

HTTPcURLJavaScriptPython

PATCH /api/v1/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/distributions/{distributionId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "status": "pending",
  "remoteId": "<remoteId>"
}

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "deploymentId": "text",
  "projectId": "text",
  "userId": "text",
  "abolisherId": "text",
  "releaseNotes": "text",
  "status": "pending",
  "startedAt": "2026-03-09T20:33:39.284Z",
  "completedAt": "2026-03-09T20:33:39.284Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "TestFlight",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2026-03-09T20:33:39.284Z",
  "updatedAt": "2026-03-09T20:33:39.284Z"
}