Organization

Operations related to the organization

Get a organization dependency

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}

Get a organization dependency by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/dependencies/{dependencyId}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/dependencies/{dependencyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a organization dependency

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}

Update a organization dependency by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

Body

application/json

isPrivatebooleanOptional

The dependency is private

Example: true

imageUrlstringOptional

The dependency image URL

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/dependencies/{dependencyId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/dependencies/{dependencyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "isPrivate": true,
  "imageUrl": "text"
}

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organization dependencies

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies

Get organization dependencies by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

textstringOptional

The text to search

isPrivatebooleanOptional

The is private to filter

Responses

200

OK

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/dependencies

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "isPrivate": true,
      "readme": "This is a readme",
      "isVisible": true,
      "_id": "63ea10b94a472e003305232b",
      "name": "akinon-cli",
      "organization": "6131198510b4640b303ebf1b",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a organization dependency

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies

Create a organization dependency by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

namestring · min: 3 · max: 255Required

The dependency name (required)

Example: akinon-cli

readmestring · max: 1000Optional

The dependency readme

Example: This is a readme

isPrivatebooleanOptional

The dependency is private

Example: true

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/dependencies

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/dependencies HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "akinon-cli",
  "readme": "This is a readme",
  "isPrivate": true
}

{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organization dependency packages

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}/packages

Get organization dependency packages by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

Query parameters

versionNumberstringOptional

The version number to filter

envVersionNumberstringOptional

The env version number to filter

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/dependencies/{dependencyId}/packages

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/dependencies/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
      "isPrivate": true,
      "readme": "This is a readme",
      "_id": "63ea10b94a472e003305232b",
      "versionNumber": "1.0.0",
      "publisher": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "Buğrahan",
        "lastName": "Öztürk"
      },
      "dependency": "63ea10b94a472e003305232b",
      "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
      "rank": 81001623508.4455,
      "envVersionNumber": "1.0.1",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a organization dependency package

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}/packages

Create a organization dependency package by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

Body

application/json

namestringRequired

The dependency package name

Example: test-plugin-1.0.0.tgz

versionNumberstringRequired

The dependency package version number

Example: 1.0.0

envVersionstringRequired

The dependency package env version

Example: 1.0.0

urlstringRequired

The dependency package url

Example: https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin/test-plugin-1.0.0.tgz

checksumstringRequired

The dependency package checksum

Example: 0a6ccf4046b552a92c6b026b414fe28f

isPrivatebooleanOptional

The dependency package is private

Example: true

readmestringOptional

The dependency package readme

Example: test readme

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/dependencies/{dependencyId}/packages

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/dependencies/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "name": "test-plugin-1.0.0.tgz",
  "versionNumber": "1.0.0",
  "envVersion": "1.0.0",
  "url": "https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin/test-plugin-1.0.0.tgz",
  "checksum": "0a6ccf4046b552a92c6b026b414fe28f",
  "isPrivate": true,
  "readme": "test readme"
}

{
  "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "isPrivate": true,
  "readme": "This is a readme",
  "_id": "63ea10b94a472e003305232b",
  "versionNumber": "1.0.0",
  "publisher": {
    "_id": "63ea10b94a472e003305232b",
    "firstName": "Buğrahan",
    "lastName": "Öztürk"
  },
  "dependency": "63ea10b94a472e003305232b",
  "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
  "rank": 81001623508.4455,
  "envVersionNumber": "1.0.1",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a organization dependency package

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}

Delete a organization dependency package by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

packageIdstringRequired

The MongoDB ID

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

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a organization dependency package signed package url

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}/download

Get a organization dependency package signed package url by admin

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

dependencyIdstringRequired

The MongoDB ID

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

packageIdstringRequired

The MongoDB ID

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

Query parameters

urlstringRequired

The url

fileNamestringOptional

The file name

Responses

201

OK

application/json

401

Unauthorized

application/json

get

/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}/download

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}/download?url=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://akinon.s3.amazonaws.com/..."
}

Get organizations deployments

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/deployments

Get organizations deployments by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/deployments

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "project": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Toys Shop",
        "slug": "hello-world",
        "description": "The best toys shop",
        "organization": "6131198510b4640b303ebf1b",
        "credential": {},
        "additionalCredentials": {},
        "appStatuses": {
          "android": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "huawei": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "ios": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            }
          }
        },
        "status": "active",
        "lastActivityAt": "2020-07-23T12:00:00.000Z",
        "appIconUrl": "https://example.com/icon.png",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "username": "[email protected]",
        "language": "en",
        "region": "us",
        "firstName": "John",
        "lastName": "Doe",
        "status": 1,
        "attributes": {
          "iamUserId": "1234567890"
        },
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2020-07-23T12:00:00.000Z",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "parent": "63ea10b94a472e003305232b",
      "description": "This is a deployment",
      "status": "success",
      "os": "android",
      "buildTarget": "production",
      "deploymentType": "build",
      "stages": [
        {
          "_id": "63ea10b94a472e003305232b",
          "name": "text",
          "createdAt": "2020-07-23T12:00:00.000Z",
          "updatedAt": "2020-07-23T12:00:00.000Z"
        }
      ],
      "startedAt": "2020-07-23T12:00:00.000Z",
      "completedAt": "2020-07-23T12:00:00.000Z",
      "abolisher": "63ea10b94a472e003305232b",
      "forceUpdate": true,
      "tag": "text",
      "checksum": "text",
      "size": 1,
      "uploadDuration": 1,
      "remoteId": 1,
      "plugins": [
        {
          "name": "text",
          "version": "text",
          "moduleName": "text"
        }
      ],
      "issues": [
        {
          "type": "error",
          "message": "text"
        }
      ],
      "timeline": [
        {
          "step": 1,
          "startTime": "2020-07-23T12:00:00.000Z",
          "finishTime": "2020-07-23T12:00:00.000Z",
          "error": "text"
        }
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z",
      "versionCode": 12,
      "javaVersion": 1.8,
      "xcodeVersion": 12,
      "extensions": [
        "com.akinon.fashfed.RelatedDigitalNotificationExtension",
        "com.akinon.fashfed.RelatedDigitalNotificationContent"
      ],
      "envVersion": "1.0.0",
      "storeVersion": "text",
      "isLive": true,
      "isOnStore": "success"
    }
  ]
}

Get organizations invitations

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/invitations

Get organizations invitations by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

statusstringOptional

The status to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/invitations

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "email": "[email protected]",
      "token": true,
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "user": "63ea10b94a472e003305232b",
      "registered": {
        "completedAt": "2020-07-23T12:00:00.000Z",
        "user": "63ea10b94a472e003305232b"
      },
      "status": "pending",
      "validatedAt": "2020-07-23T12:00:00.000Z",
      "_id": "63ea10b94a472e003305232b",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a organization invitation

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/invitations

Create a organization invitation by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

emailstring · min: 3 · max: 255Required

The invitation email

Example: [email protected]

rolesstring[]Optional

The MongoDB ID

Example: 63ea10b94a472e003305232b

validatedAtstring · date-timeRequired

The date

Example: 2024-07-23T12:00:00.000Z

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/invitations

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/invitations HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "email": "[email protected]",
  "roles": [
    "63ea10b94a472e003305232b"
  ],
  "validatedAt": "2024-07-23T12:00:00.000Z"
}

{
  "email": "[email protected]",
  "token": true,
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": "63ea10b94a472e003305232b",
  "registered": {
    "completedAt": "2020-07-23T12:00:00.000Z",
    "user": "63ea10b94a472e003305232b"
  },
  "status": "pending",
  "validatedAt": "2020-07-23T12:00:00.000Z",
  "_id": "63ea10b94a472e003305232b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations privileges

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/privileges

Get organizations privileges by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/privileges

HTTPcURLJavaScriptPython

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

{
  "organization": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "group": "administration"
    }
  ]
}

Set organizations project status

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/activate

Set organizations project status by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/projects/{projectId}/activate

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Set organizations project status

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/deactivate

Set organizations project status by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/projects/{projectId}/deactivate

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project credential

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credential

Get organizations project credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/credential

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "credential": {
    "android": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "huawei": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "ios": {
      "production": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      },
      "staging": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      }
    }
  }
}

Update organizations project credential

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credential

Update organizations project credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/credential

HTTPcURLJavaScriptPython

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

{
  "android": {
    "production": {
      "keystore": "text",
      "keystorePassword": "text",
      "keyAlias": "text",
      "keyPassword": "text"
    },
    "staging": {
      "keystore": "text",
      "keystorePassword": "text",
      "keyAlias": "text",
      "keyPassword": "text"
    }
  },
  "huawei": {
    "production": {
      "keystore": "text",
      "keystorePassword": "text",
      "keyAlias": "text",
      "keyPassword": "text"
    },
    "staging": {
      "keystore": "text",
      "keystorePassword": "text",
      "keyAlias": "text",
      "keyPassword": "text"
    }
  },
  "ios": {
    "production": {
      "provisioningProfile": "text",
      "certificate": "text",
      "password": "text",
      "certificateApn": "text",
      "certificateApnKey": "text",
      "provisioningExpiration": "2024-07-23T12:00:00.000Z",
      "certificateExpiration": "2024-07-23T12:00:00.000Z"
    },
    "staging": {
      "provisioningProfile": "text",
      "certificate": "text",
      "password": "text",
      "certificateApn": "text",
      "certificateApnKey": "text",
      "provisioningExpiration": "2024-07-23T12:00:00.000Z",
      "certificateExpiration": "2024-07-23T12:00:00.000Z"
    }
  }
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": {
    "android": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "huawei": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "ios": {
      "production": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      },
      "staging": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      }
    }
  },
  "additionalCredentials": {
    "ios": {
      "production": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ],
      "staging": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ]
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project unsafe credential

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credential/show-password/{name}

Get organizations project unsafe credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

namestringRequired

The credential name

Example: android.staging.keyPassword

Responses

200

OK

application/json

Responsestring

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/credential/show-password/{name}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/projects/{projectId}/credential/show-password/{name} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Update organizations project credential file

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credential/file

Update organizations project credential file by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

osstring · enumRequired

The deployment OS

Example: androidPossible values:

buildTargetstring · enumRequired

The deployment build target

Example: productionPossible values:

provisioningProfilestringOptional

The deployment provisioning profile

Example: 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).mobileprovision

keystorestringOptional

The deployment keystore

Example: https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/1d5c0b7e-c098-40f4-b6e2-9256bd5b9fa4_d53a3d0f-82e6-4df4-bd65-855c25bd5e73_74b184f9-22d5-49ab-a58d-73ee7931a704_akinon-test-(6).keystore

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/credential/file

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/credential/file HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 490

{
  "os": "android",
  "buildTarget": "production",
  "provisioningProfile": "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).mobileprovision",
  "keystore": "https://test-mobile-prv.s3.eu-central-1.amazonaws.com//_temp/1d5c0b7e-c098-40f4-b6e2-9256bd5b9fa4_d53a3d0f-82e6-4df4-bd65-855c25bd5e73_74b184f9-22d5-49ab-a58d-73ee7931a704_akinon-test-(6).keystore"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": {
    "android": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "huawei": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "ios": {
      "production": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      },
      "staging": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      }
    }
  },
  "additionalCredentials": {
    "ios": {
      "production": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ],
      "staging": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ]
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project credential validation

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credential/validation

Get organizations project credential validation by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/credential/validation

HTTPcURLJavaScriptPython

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

[
  {
    "message": "text",
    "path": "text",
    "type": "text",
    "context": {}
  }
]

Get organizations projects

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects

Get organizations projects by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

statusstring · enumOptional

The project status

Possible values:

limitintegerOptional

The limit of per page

Default: 10

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

Responses

200

OK

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Toys Shop",
      "slug": "hello-world",
      "description": "The best toys shop",
      "organization": "63ea10b94a472e003305232b",
      "credential": {
        "android": {
          "production": {
            "keystore": "text",
            "keystorePassword": "text",
            "keyAlias": "text",
            "keyPassword": "text"
          },
          "staging": {
            "keystore": "text",
            "keystorePassword": "text",
            "keyAlias": "text",
            "keyPassword": "text"
          }
        },
        "huawei": {
          "production": {
            "keystore": "text",
            "keystorePassword": "text",
            "keyAlias": "text",
            "keyPassword": "text"
          },
          "staging": {
            "keystore": "text",
            "keystorePassword": "text",
            "keyAlias": "text",
            "keyPassword": "text"
          }
        },
        "ios": {
          "production": {
            "provisioningProfile": "text",
            "certificate": "text",
            "password": "text",
            "certificateApn": "text",
            "certificateApnKey": "text",
            "provisioningExpiration": "2024-07-23T12:00:00.000Z",
            "certificateExpiration": "2024-07-23T12:00:00.000Z"
          },
          "staging": {
            "provisioningProfile": "text",
            "certificate": "text",
            "password": "text",
            "certificateApn": "text",
            "certificateApnKey": "text",
            "provisioningExpiration": "2024-07-23T12:00:00.000Z",
            "certificateExpiration": "2024-07-23T12:00:00.000Z"
          }
        }
      },
      "additionalCredentials": {
        "ios": {
          "production": [
            {
              "bundleIdentifier": "com.example.app",
              "provisioningProfile": "text",
              "provisioningExpiration": "2024-07-23T12:00:00.000Z"
            }
          ],
          "staging": [
            {
              "bundleIdentifier": "com.example.app",
              "provisioningProfile": "text",
              "provisioningExpiration": "2024-07-23T12:00:00.000Z"
            }
          ]
        }
      },
      "appStatuses": {
        "android": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          }
        },
        "huawei": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z",
            "versionCode": 12
          }
        },
        "ios": {
          "production": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z"
          },
          "staging": {
            "createdAt": "2024-04-04T14:17:55.294Z",
            "deploymentId": "5f72f51d0b29d2003e48f746",
            "envVersion": "1.0.0",
            "publishedAt": "2024-04-04T14:17:55.294Z",
            "publisher": "5f72f51d0b29d2003e48f746",
            "status": true,
            "storeVersion": "1.0.0",
            "tag": "v4.2.0-2.0.2",
            "updatedAt": "2024-04-04T14:17:55.294Z"
          }
        }
      },
      "status": "active",
      "lastActivityAt": "2020-07-23T12:00:00.000Z",
      "appIconUrl": "https://example.com/icon.png",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Create a organization project

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects

Create a organization project by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

namestringRequired

The project name

Example: akinon

descriptionstringOptional

The project description

Example: this is a test project

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/projects

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/projects HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "name": "akinon",
  "description": "this is a test project"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": {
    "android": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "huawei": {
      "production": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      },
      "staging": {
        "keystore": "text",
        "keystorePassword": "text",
        "keyAlias": "text",
        "keyPassword": "text"
      }
    },
    "ios": {
      "production": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      },
      "staging": {
        "provisioningProfile": "text",
        "certificate": "text",
        "password": "text",
        "certificateApn": "text",
        "certificateApnKey": "text",
        "provisioningExpiration": "2024-07-23T12:00:00.000Z",
        "certificateExpiration": "2024-07-23T12:00:00.000Z"
      }
    }
  },
  "additionalCredentials": {
    "ios": {
      "production": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ],
      "staging": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ]
    }
  },
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a organization project

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The project ID

Example: 1234567890abcdef12345678 or my-project

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a organization project

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Update a organization project by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

appIconUrlstringOptional

The project app icon URL

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "appIconUrl": "text"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Force to update a project

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/force-update

Force to update a project by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

forceUpdatebooleanRequired

The project force update

Example: true

buildIdsstring[]Required

The MongoDB ID

Example: 63ea10b94a472e003305232b

Responses

201

Created

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/organizations/{organizationId}/projects/{projectId}/force-update

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/projects/{projectId}/force-update HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "forceUpdate": true,
  "buildIds": [
    "63ea10b94a472e003305232b"
  ]
}

No content

Get organizations project git repository

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/git-repository

Get organizations project git repository by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/git-repository

HTTPcURLJavaScriptPython

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

{
  "repositoryName": "appm_test_administrator_test-61",
  "lastModifiedDate": "2023-11-26T07:30:24.196Z",
  "cloneUrlSsh": "ssh://git-codecommit.eu-central-1.amazonaws.com/v1/repos/appm_test_administrator_test-61",
  "cloneUrlHttp": "https://git-codecommit.eu-central-1.amazonaws.com/v1/repos/appm_test_administrator_test-61"
}

Get organizations project artifact download url

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/artifacts/download

Get organizations project artifact download url by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Query parameters

urlstringRequired

The url

fileNamestringOptional

The file name

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/artifacts/download

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/projects/{projectId}/artifacts/download?url=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://akinon.s3.amazonaws.com/..."
}

Get organizations project credential download url

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/credentials/download

Get organizations project credential download url by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Query parameters

urlstringRequired

The url

fileNamestringOptional

The file name

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/credentials/download

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/projects/{projectId}/credentials/download?url=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "https://akinon.s3.amazonaws.com/..."
}

Get a organization project additional credentials

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/additional-credentials

Get a organization project additional credentials by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/additional-credentials

HTTPcURLJavaScriptPython

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

{
  "additionalCredentials": {
    "ios": {
      "production": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ],
      "staging": [
        {
          "bundleIdentifier": "com.example.app",
          "provisioningProfile": "text",
          "provisioningExpiration": "2024-07-23T12:00:00.000Z"
        }
      ]
    }
  }
}

Create a organization project additional credential

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}

Create a organization project additional credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

platformstring · enumRequired

The platform

Possible values:

envstring · enumRequired

The env

Possible values:

Body

application/json

provisioningProfilestringRequired

The deployment provisioning profile

Example: 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).mobileprovision

bundleIdentifierstringRequired

The deployment bundle identifier

Example: com.akinon.test

Responses

201

Created

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "provisioningProfile": "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).mobileprovision",
  "bundleIdentifier": "com.akinon.test"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a organization project additional credential

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

Delete a organization project additional credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

platformstring · enumRequired

The platform

Possible values:

envstring · enumRequired

The env

Possible values:

bundleIdentifierstringRequired

The bundle identifier

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

delete

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a organization project additional credential

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

Update a organization project additional credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

platformstring · enumRequired

The platform

Possible values:

envstring · enumRequired

The env

Possible values:

bundleIdentifierstringRequired

The bundle identifier

Body

application/json

provisioningProfilestringOptional

The deployment provisioning profile

Example: 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).mobileprovision

bundleIdentifierstringOptional

The deployment bundle identifier

Example: com.akinon.test

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

patch

/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/additional-credentials/{platform}/{env}/{bundleIdentifier} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "provisioningProfile": "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).mobileprovision",
  "bundleIdentifier": "com.akinon.test"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project deployments

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get organizations project deployments by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

deploymentTypestring · enumOptional

The deploymentType to filter

Possible values:

isLivebooleanOptional

The is live to filter

isOnStorestring · enumOptional

The is on store to filter

Possible values:

statusstringOptional

The status to filter

osstring · enumOptional

The os to filter

Possible values:

buildTargetstring · enumOptional

The buildTarget to filter

Possible values:

forceUpdatebooleanOptional

The force update to filter

envVersionstringOptional

The env version to filter

storeVersionstringOptional

The store version to filter

parentstringOptional

The parent to filter

createdBystringOptional

The MongoDB ID

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

createdAtstringOptional

The created at date

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "_id": "63ea10b94a472e003305232b",
      "project": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Toys Shop",
        "slug": "hello-world",
        "description": "The best toys shop",
        "organization": "6131198510b4640b303ebf1b",
        "credential": {},
        "additionalCredentials": {},
        "appStatuses": {
          "android": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "huawei": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z",
              "versionCode": 12
            }
          },
          "ios": {
            "production": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            },
            "staging": {
              "createdAt": "2024-04-04T14:17:55.294Z",
              "deploymentId": "5f72f51d0b29d2003e48f746",
              "envVersion": "1.0.0",
              "publishedAt": "2024-04-04T14:17:55.294Z",
              "publisher": "5f72f51d0b29d2003e48f746",
              "status": true,
              "storeVersion": "1.0.0",
              "tag": "v4.2.0-2.0.2",
              "updatedAt": "2024-04-04T14:17:55.294Z"
            }
          }
        },
        "status": "active",
        "lastActivityAt": "2020-07-23T12:00:00.000Z",
        "appIconUrl": "https://example.com/icon.png",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "user": {
        "_id": "63ea10b94a472e003305232b",
        "username": "[email protected]",
        "language": "en",
        "region": "us",
        "firstName": "John",
        "lastName": "Doe",
        "status": 1,
        "attributes": {
          "iamUserId": "1234567890"
        },
        "avatarUrl": "text",
        "settings": {
          "mailOnBuildCompleted": true,
          "mailOnCodePushCompleted": true
        },
        "lastLoginAt": "2020-07-23T12:00:00.000Z",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "parent": "63ea10b94a472e003305232b",
      "description": "This is a deployment",
      "status": "success",
      "os": "android",
      "buildTarget": "production",
      "deploymentType": "build",
      "stages": [
        {
          "_id": "63ea10b94a472e003305232b",
          "name": "text",
          "createdAt": "2020-07-23T12:00:00.000Z",
          "updatedAt": "2020-07-23T12:00:00.000Z"
        }
      ],
      "startedAt": "2020-07-23T12:00:00.000Z",
      "completedAt": "2020-07-23T12:00:00.000Z",
      "abolisher": "63ea10b94a472e003305232b",
      "forceUpdate": true,
      "tag": "text",
      "checksum": "text",
      "size": 1,
      "uploadDuration": 1,
      "remoteId": 1,
      "plugins": [
        {
          "name": "text",
          "version": "text",
          "moduleName": "text"
        }
      ],
      "issues": [
        {
          "type": "error",
          "message": "text"
        }
      ],
      "timeline": [
        {
          "step": 1,
          "startTime": "2020-07-23T12:00:00.000Z",
          "finishTime": "2020-07-23T12:00:00.000Z",
          "error": "text"
        }
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z",
      "versionCode": 12,
      "javaVersion": 1.8,
      "xcodeVersion": 12,
      "extensions": [
        "com.akinon.fashfed.RelatedDigitalNotificationExtension",
        "com.akinon.fashfed.RelatedDigitalNotificationContent"
      ],
      "envVersion": "1.0.0",
      "storeVersion": "text",
      "isLive": true,
      "isOnStore": "success"
    }
  ]
}

Create a organization project deployment

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Create a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

userstringRequired

The MongoDB ID

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

statusstring · enumRequired

The deployment status

Example: pendingPossible values:

descriptionstringOptional

The deployment description

Example: test

tagstringRequired

The deployment tag

Example: 1.0.0

deploymentTypestring · enumRequired

The deployment type

Possible values:

buildTargetstring · enumRequired

The deployment build target

Possible values:

forceUpdatebooleanOptional

The deployment force update

Default: falseExample: true

osstring · enumRequired

The deployment os

Possible values:

parentstringOptional

The MongoDB ID

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

isMandatorybooleanOptional

The deployment mandatory

Default: falseExample: true

targetBinaryRangestringOptional

The deployment target binary range

Example: 1.0.0

Responses

201

Created

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "user": "63ea10b94a472e003305232b",
  "status": "pending",
  "description": "test",
  "tag": "1.0.0",
  "deploymentType": "build",
  "buildTarget": "staging",
  "forceUpdate": true,
  "os": "android",
  "parent": "63ea10b94a472e003305232b",
  "isMandatory": true,
  "targetBinaryRange": "1.0.0"
}

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Get a organization project deployment

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Update a organization project deployment

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Update a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Body

application/json

statusstring · enumOptional

The status of the deployment in appmaker

Example: pendingPossible values:

stageany ofOptional

stringOptional

The deployment stage

Example: Deployment starting..

or

string[]Optional

The deployment stages

Example: Deployment starting..

checksumstringOptional

The deployment package checksum

Example: 0a6ccf4046b552a92c6b026b414fe28f

sizenumberOptional

The deployment package size in bytes

Example: 123123

uploadDurationnumberOptional

The deployment upload duration in seconds

Example: 123

remoteIdnumberOptional

The deployment build service id

Example: 1

labelstringOptional

The deployment code push label

Example: v1

isDisabledbooleanOptional

The deployment code push is disabled

Example: true

rolloutnumber · max: 100Optional

The deployment code push rollout

Example: 100

releaseMethodstring · enumOptional

The deployment code push release method

Example: uploadPossible values:

xcodeVersionstringOptional

The deployment xcode version

Example: 12

extensionsstring[]Optional

The ios app extensions

Example: com.akinon.test

javaVersionstringOptional

The java version for android and huawei

Example: 1.8

versionCodenumberOptional

The deployment version code

Example: 1

envVersionstringOptional

The deployment env version

Example: 1.0.0

storeVersionstringOptional

The deployment store version

Example: 1.0.0

isOnStorestring · enumOptional

The deployment is on store

Example: successPossible values:

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

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}

HTTPcURLJavaScriptPython

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

{
  "status": "pending",
  "stage": "Deployment starting..",
  "checksum": "0a6ccf4046b552a92c6b026b414fe28f",
  "size": 123123,
  "uploadDuration": 123,
  "remoteId": 1,
  "label": "v1",
  "isDisabled": true,
  "rollout": 100,
  "releaseMethod": "upload",
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.test"
  ],
  "javaVersion": 1.8,
  "versionCode": 1,
  "envVersion": "1.0.0",
  "storeVersion": "1.0.0",
  "isOnStore": "success",
  "plugins": [
    {
      "name": "test-plugin",
      "version": "1.0.0",
      "moduleName": "TestPlugin"
    }
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Get a organization project deployment timeline

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project deployment timeline by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

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

[
  {
    "step": 1,
    "startTime": "2020-07-23T12:00:00.000Z",
    "finishTime": "2020-07-23T12:00:00.000Z",
    "error": "text",
    "current": true
  }
]

Get a organization project deployment app download url

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/app-download-url/{downloadType}

Get a organization project deployment app download url by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

downloadTypestring · enumRequired

The download type

Possible values:

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/app-download-url/{downloadType}

HTTPcURLJavaScriptPython

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

{
  "body": {
    "uri": "https://build.appcenter.ms/v0.1/public/apps/ecef04b2-08c5-41d3-a51c-b09654c6e038/downloads?token=080e544ae36d2705150f9ec5b636714ea5b8b8667974b03847e84a7aebd2c668"
  }
}

Cancel a organization project deployment

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Cancel a organization project deployment by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

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/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/cancel HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Update deployment store state

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Update deployment store state by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Body

application/json

isOnStorestring · enumRequiredPossible values:

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

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/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": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Get a organization project deployment metrics

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project deployment metrics by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/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/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Update a organization project deployment release by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Body

application/json

Responses

200

OK

application/json

Responseone of

all ofOptional

and

or

all ofOptional

and

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/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: 113

{
  "release": {
    "targetBinaryRange": "1.0.0",
    "description": "test",
    "isDisabled": true,
    "isMandatory": true,
    "rollout": 100
  }
}

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "build",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "versionCode": 12,
  "javaVersion": 1.8,
  "xcodeVersion": 12,
  "extensions": [
    "com.akinon.fashfed.RelatedDigitalNotificationExtension",
    "com.akinon.fashfed.RelatedDigitalNotificationContent"
  ],
  "envVersion": "1.0.0",
  "storeVersion": "text",
  "isLive": true,
  "isOnStore": "success"
}

Rollback a organization project deployment code push

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Rollback a organization project deployment code push by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Body

application/json

releaseLabelstringRequired

The code push label

Example: v1

Responses

200

OK

application/json

Responseall of

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/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: 21

{
  "releaseLabel": "v1"
}

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "code-push",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "targetBinaryRange": "1.0.0",
  "label": "v4.2.0-2.0.2",
  "originalLabel": "v4.2.0-2.0.2",
  "isMandatory": true,
  "isDisabled": true,
  "rollout": 100,
  "releaseMethod": "upload"
}

Promote a organization project deployment code push

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Promote a organization project deployment code push by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseall of

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/organizations/{organizationId}/projects/{projectId}/deployments/{deploymentId}/promote-release HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "project": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Toys Shop",
    "slug": "hello-world",
    "description": "The best toys shop",
    "organization": "6131198510b4640b303ebf1b",
    "credential": {},
    "additionalCredentials": {},
    "appStatuses": {
      "android": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "huawei": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z",
          "versionCode": 12
        }
      },
      "ios": {
        "production": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        },
        "staging": {
          "createdAt": "2024-04-04T14:17:55.294Z",
          "deploymentId": "5f72f51d0b29d2003e48f746",
          "envVersion": "1.0.0",
          "publishedAt": "2024-04-04T14:17:55.294Z",
          "publisher": "5f72f51d0b29d2003e48f746",
          "status": true,
          "storeVersion": "1.0.0",
          "tag": "v4.2.0-2.0.2",
          "updatedAt": "2024-04-04T14:17:55.294Z"
        }
      }
    },
    "status": "active",
    "lastActivityAt": "2020-07-23T12:00:00.000Z",
    "appIconUrl": "https://example.com/icon.png",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "user": {
    "_id": "63ea10b94a472e003305232b",
    "username": "[email protected]",
    "language": "en",
    "region": "us",
    "firstName": "John",
    "lastName": "Doe",
    "status": 1,
    "attributes": {
      "iamUserId": "1234567890"
    },
    "avatarUrl": "text",
    "settings": {
      "mailOnBuildCompleted": true,
      "mailOnCodePushCompleted": true
    },
    "lastLoginAt": "2020-07-23T12:00:00.000Z",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "parent": "63ea10b94a472e003305232b",
  "description": "This is a deployment",
  "status": "success",
  "os": "android",
  "buildTarget": "production",
  "deploymentType": "code-push",
  "stages": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ],
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "abolisher": "63ea10b94a472e003305232b",
  "forceUpdate": true,
  "tag": "text",
  "checksum": "text",
  "size": 1,
  "uploadDuration": 1,
  "remoteId": 1,
  "plugins": [
    {
      "name": "text",
      "version": "text",
      "moduleName": "text"
    }
  ],
  "issues": [
    {
      "type": "error",
      "message": "text"
    }
  ],
  "timeline": [
    {
      "step": 1,
      "startTime": "2020-07-23T12:00:00.000Z",
      "finishTime": "2020-07-23T12:00:00.000Z",
      "error": "text"
    }
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "targetBinaryRange": "1.0.0",
  "label": "v4.2.0-2.0.2",
  "originalLabel": "v4.2.0-2.0.2",
  "isMandatory": true,
  "isDisabled": true,
  "rollout": 100,
  "releaseMethod": "upload"
}

Get a organization project deployment distributions

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project deployment distributions by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/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": "63ea10b94a472e003305232b",
    "projectId": "63ea10b94a472e003305232b",
    "userId": "63ea10b94a472e003305232b",
    "abolisherId": "63ea10b94a472e003305232b",
    "releaseNotes": "This is a release note",
    "status": "pending",
    "startedAt": "2020-07-23T12:00:00.000Z",
    "completedAt": "2020-07-23T12:00:00.000Z",
    "remoteId": 1234567890,
    "releaseMethod": "upload",
    "track": "production",
    "uploadMetadata": false,
    "uploadScreenshots": false,
    "shouldSubmitForReview": false,
    "shouldAutoRelease": false,
    "userFraction": 1,
    "updatePriority": 0,
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  }
]

Create a organization project deployment distribution

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Create a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

Body

application/json

releaseNotesstringRequired

The deployment release notes

Example: This is a release note

releaseMethodstring · enumOptional

The deployment release method

Possible values:

trackstring · enumRequired

The deployment track

Possible values:

uploadMetadatabooleanOptional

The deployment upload metadata

Default: falseExample: true

uploadScreenshotsbooleanOptional

The deployment upload screenshots

Default: falseExample: true

shouldSubmitForReviewbooleanOptional

The deployment should submit for review

Default: falseExample: true

shouldAutoReleasebooleanOptional

The deployment should auto release

Default: falseExample: true

userFractionnumber · max: 1Optional

The deployment user fraction

Default: 1Example: 1

updatePrioritynumber · max: 5Optional

The deployment update priority

Default: 0Example: 0

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/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: 224

{
  "releaseNotes": "This is a release note",
  "releaseMethod": "upload",
  "track": "TestFlight",
  "uploadMetadata": true,
  "uploadScreenshots": true,
  "shouldSubmitForReview": true,
  "shouldAutoRelease": true,
  "userFraction": 1,
  "updatePriority": 0
}

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "deploymentId": "63ea10b94a472e003305232b",
  "projectId": "63ea10b94a472e003305232b",
  "userId": "63ea10b94a472e003305232b",
  "abolisherId": "63ea10b94a472e003305232b",
  "releaseNotes": "This is a release note",
  "status": "pending",
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "production",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a organization project deployment distribution

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Get a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

distributionIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/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": "63ea10b94a472e003305232b",
  "projectId": "63ea10b94a472e003305232b",
  "userId": "63ea10b94a472e003305232b",
  "abolisherId": "63ea10b94a472e003305232b",
  "releaseNotes": "This is a release note",
  "status": "pending",
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "production",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a organization project deployment distribution

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

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

Update a organization project deployment distribution by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

deploymentIdstringRequired

The MongoDB ID

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

distributionIdstringRequired

The MongoDB ID

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

Body

application/json

statusstring · enumOptional

The deployment status

Possible values:

remoteIdnumberOptional

The deployment remote id

Example: 1234567890

Responses

200

OK

application/json

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/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: 42

{
  "status": "pending",
  "remoteId": 1234567890
}

{
  "_id": "63ea10b94a472e003305232b",
  "type": 1,
  "deploymentId": "63ea10b94a472e003305232b",
  "projectId": "63ea10b94a472e003305232b",
  "userId": "63ea10b94a472e003305232b",
  "abolisherId": "63ea10b94a472e003305232b",
  "releaseNotes": "This is a release note",
  "status": "pending",
  "startedAt": "2020-07-23T12:00:00.000Z",
  "completedAt": "2020-07-23T12:00:00.000Z",
  "remoteId": 1234567890,
  "releaseMethod": "upload",
  "track": "production",
  "uploadMetadata": false,
  "uploadScreenshots": false,
  "shouldSubmitForReview": false,
  "shouldAutoRelease": false,
  "userFraction": 1,
  "updatePriority": 0,
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project webhooks

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Get organizations project webhooks by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/settings/webhooks

HTTPcURLJavaScriptPython

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

[
  {
    "_id": "63ea10b94a472e003305232b",
    "name": "My Webhook",
    "url": "https://example.com/webhook",
    "headers": {},
    "active": true,
    "events": [
      "deployment.build.created"
    ],
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  }
]

Create a organization project webhook

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/webhooks

Create a organization project webhook by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

namestringRequired

The webhook name

Example: My Webhook

urlstringRequired

The webhook URL

Example: https://example.com/webhook

headersobjectOptional

The webhook headers

activebooleanOptional

The webhook active status

Default: trueExample: true

eventsstring[]Required

The webhook events

Example: ["deployment.build.created"]

Responses

201

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/projects/{projectId}/settings/webhooks

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/projects/{projectId}/settings/webhooks HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "headers": {},
  "active": true,
  "events": [
    [
      "deployment.build.created"
    ]
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations a project webhook

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Get a organization project webhook by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

webhookIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "headers": {},
  "active": true,
  "events": [
    "deployment.build.created"
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a project webhook

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Delete a project webhook by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

webhookIdstringRequired

The MongoDB ID

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

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a project webhook

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

Update a project webhook by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

webhookIdstringRequired

The MongoDB ID

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

Body

application/json

namestringOptional

The webhook name

Example: My Webhook

urlstringOptional

The webhook URL

Example: https://example.com/webhook

headersobjectOptional

The webhook headers

activebooleanOptional

The webhook active status

Default: trueExample: true

eventsstring[]Optional

The webhook events

Example: ["deployment.build.created"]

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/settings/webhooks/{webhookId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "headers": {},
  "active": true,
  "events": [
    [
      "deployment.build.created"
    ]
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project envvars

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/envvars

Get organizations project envvars by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/settings/envvars

HTTPcURLJavaScriptPython

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

[
  {
    "_id": "63ea10b94a472e003305232b",
    "name": "MY_ENV_VAR",
    "value": "my_value",
    "isSecret": false,
    "env": "production",
    "authorId": "63ea10b94a472e003305232b",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  }
]

Create a organization project envvar

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/envvars

Create a organization project envvars by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

namestringRequired

The envvar name

Example: MY_ENV_VAR

valuestringRequired

The envvar value

Example: my_value

envstring · enumRequired

The envvar environment

Example: stagingPossible values:

isSecretbooleanOptional

The envvar is secret

Default: falseExample: true

Responses

201

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/projects/{projectId}/settings/envvars

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/projects/{projectId}/settings/envvars HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "name": "MY_ENV_VAR",
  "value": "my_value",
  "env": "staging",
  "isSecret": true
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations a project envvar

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Get a organization project envvar by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

envvarIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

HTTPcURLJavaScriptPython

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

{
  "_id": "63ea10b94a472e003305232b",
  "name": "MY_ENV_VAR",
  "value": "my_value",
  "isSecret": false,
  "env": "production",
  "authorId": "63ea10b94a472e003305232b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a project envvar

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Delete a project envvar by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

envvarIdstringRequired

The MongoDB ID

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

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a project envvar

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

Update a project envvar by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

envvarIdstringRequired

The MongoDB ID

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

Body

application/json

valuestringOptional

The envvar value

Example: my_value

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/settings/envvars/{envvarId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "value": "my_value"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations project store credential validation

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/store-credentials/validation

Get organizations project store credential validation by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/projects/{projectId}/store-credentials/validation

HTTPcURLJavaScriptPython

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

[
  {
    "message": "text",
    "path": "text",
    "type": "text",
    "context": {}
  }
]

Update a project apple app store credential

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/store-credentials/apple-app-store

Update a project apple app store credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

keyIdstringOptional

The Apple key id

Example: ABCDEFGHIJ

keyIssuerIdstringOptional

The Apple issuer id

Example: 12345678-1234-1234-1234-123456789012

apiKeyFilestringOptional

The Apple api key file

Example: 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

keyInHousebooleanOptional

The Apple key in house

Default: falseExample: true

appIdentifierstringOptional

The Apple app identifier

Example: com.akinon.test

teamIdstringOptional

The Apple team id

Example: ABCDEFGHIJ

teamNamestringOptional

The Apple team name

Example: Akinon Team

appSpecificIdstringOptional

The Apple app specific id

Example: 1234567890

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/store-credentials/apple-app-store

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/store-credentials/apple-app-store HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 416

{
  "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
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a project google play credential

patch

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/projects/{projectId}/store-credentials/google-play

Update a project google play credential by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

projectIdstringRequired

The MongoDB ID

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

Body

application/json

googleServiceFilestringOptional

The Google Play service file url

Example: The Google Play service

packageNamestringOptional

The Google Play package name

Example: com.akinon.test

Responses

200

OK

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

/organizations/{organizationId}/projects/{projectId}/store-credentials/google-play

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/projects/{projectId}/store-credentials/google-play HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "googleServiceFile": "The Google Play service",
  "packageName": "com.akinon.test"
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Toys Shop",
  "slug": "hello-world",
  "description": "The best toys shop",
  "organization": "63ea10b94a472e003305232b",
  "credential": null,
  "additionalCredentials": null,
  "appStatuses": {
    "android": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "huawei": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z",
        "versionCode": 12
      }
    },
    "ios": {
      "production": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      },
      "staging": {
        "createdAt": "2024-04-04T14:17:55.294Z",
        "deploymentId": "5f72f51d0b29d2003e48f746",
        "envVersion": "1.0.0",
        "publishedAt": "2024-04-04T14:17:55.294Z",
        "publisher": "5f72f51d0b29d2003e48f746",
        "status": true,
        "storeVersion": "1.0.0",
        "tag": "v4.2.0-2.0.2",
        "updatedAt": "2024-04-04T14:17:55.294Z"
      }
    }
  },
  "status": "active",
  "lastActivityAt": "2020-07-23T12:00:00.000Z",
  "appIconUrl": "https://example.com/icon.png",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get organizations roles

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/roles

Get organizations roles by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

textstringOptional

The text to search

privilegesstringOptional

The privileges to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/roles

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": []
}

Create a organization role

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/roles

Create a organization role by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

namestringOptional

The role name

Example: admin

descriptionstringOptional

The role description

Example: admin role

privilegesstring[]Optional

The role privileges

Example: all:user:write

statusnumberOptional

The role status

Example: 1

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/roles

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/roles HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "name": "admin",
  "description": "admin role",
  "privileges": [
    "all:user:write"
  ],
  "status": 1
}

{
  "_id": "63ea10b94a472e003305232b",
  "organization": "63ea10b94a472e003305232b",
  "name": "admin",
  "privileges": [
    "all:user:write"
  ],
  "status": 1,
  "createdAt": "2024-07-23T12:00:00.000Z",
  "updatedAt": "2024-07-23T12:00:00.000Z"
}

Get a organization role

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/roles/{roleId}

Get a organization role by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

roleIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Presentation",
  "description": "Presentation role",
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "privileges": [
    "project:read",
    "project:write"
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Update a organization role

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/roles/{roleId}

Update a organization role by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

roleIdstringRequired

The MongoDB ID

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

Body

application/json

namestringOptional

The role name

Example: admin

descriptionstringOptional

The role description

Example: admin role

privilegesstring[]Optional

The role privileges

Example: all:user:write

statusnumberOptional

The role status

Example: 1

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

PUT /api/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "name": "admin",
  "description": "admin role",
  "privileges": [
    "all:user:write"
  ],
  "status": 1
}

{
  "_id": "63ea10b94a472e003305232b",
  "name": "Presentation",
  "description": "Presentation role",
  "organization": {
    "_id": "63ea10b94a472e003305232b",
    "name": "Akinon",
    "slug": "hello-world",
    "description": "Akinon is a software company",
    "owner": "63ea10b94a472e003305232b",
    "isExecutive": false,
    "status": 1,
    "privileges": [
      "project:read",
      "project:write"
    ],
    "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
    "createdAt": "2020-07-23T12:00:00.000Z",
    "updatedAt": "2020-07-23T12:00:00.000Z"
  },
  "privileges": [
    "project:read",
    "project:write"
  ],
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a organization role

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/roles/{roleId}

Delete a organization role by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

roleIdstringRequired

The MongoDB ID

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

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/roles/{roleId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/roles/{roleId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Init public multipart upload

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/upload/multipart/presign/public

Init public multipart upload by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

fileNamestringRequired

The file name

bucketstringOptional

The base directory name to upload the file

Default: temp

partCountinteger · min: 2Optional

The part count to upload the chunked file. This is required for chunked file uploads.

paramsstringOptional

The params for the file upload

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/upload/multipart/presign/public

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/upload/multipart/presign/public?fileName=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "urls": [
    "https://test-mobile-prv.s3.eu-central-1.amazonaws.com/_temp/f531f833-9fa9-4402-baa4-632fb45ace50_test.jpg"
  ],
  "Bucket": "acexamplebucket",
  "Key": "test.apk",
  "UploadId": "UploadId"
}

Init private multipart upload

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/upload/multipart/presign/private

Init private multipart upload by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

fileNamestringRequired

The file name

bucketstringOptional

The base directory name to upload the file

Default: temp

partCountinteger · min: 2Optional

The part count to upload the chunked file. This is required for chunked file uploads.

paramsstringOptional

The params for the file upload

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/upload/multipart/presign/private

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/upload/multipart/presign/private?fileName=text HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "urls": [
    "https://test-mobile-prv.s3.eu-central-1.amazonaws.com/_temp/f531f833-9fa9-4402-baa4-632fb45ace50_test.jpg"
  ],
  "Bucket": "acexamplebucket",
  "Key": "test.apk",
  "UploadId": "UploadId"
}

Complete public multipart upload

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/upload/multipart/complete/public

Complete public multipart upload by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

keystringRequired

The file key

Example: test.apk

uploadIdstringRequired

The upload id

Example: 2

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

put

/organizations/{organizationId}/upload/multipart/complete/public

HTTPcURLJavaScriptPython

PUT /api/organizations/{organizationId}/upload/multipart/complete/public HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "key": "test.apk",
  "uploadId": 2,
  "tags": [
    {
      "ETag": "d41d8cd98f00b204e9800998ecf8427e",
      "PartNumber": 1
    }
  ]
}

{
  "Bucket": "acexamplebucket",
  "ETag": "d41d8cd98f00b204e9800998ecf8427e",
  "Key": "test.apk",
  "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
}

Complete private multipart upload

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/upload/multipart/complete/private

Complete private multipart upload by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

keystringRequired

The file key

Example: test.apk

uploadIdstringRequired

The upload id

Example: 2

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

put

/organizations/{organizationId}/upload/multipart/complete/private

HTTPcURLJavaScriptPython

PUT /api/organizations/{organizationId}/upload/multipart/complete/private HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "key": "test.apk",
  "uploadId": 2,
  "tags": [
    {
      "ETag": "d41d8cd98f00b204e9800998ecf8427e",
      "PartNumber": 1
    }
  ]
}

{
  "Bucket": "acexamplebucket",
  "ETag": "d41d8cd98f00b204e9800998ecf8427e",
  "Key": "test.apk",
  "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
}

Get organizations users

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users

Get organizations users by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

usernamestringOptional

The username to search

sortstringOptional

The sort by field

Example: {"value":"createdAt"}

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

The current page

Default: 1

statusstringOptional

The status to filter

rolestringOptional

The role ID to filter

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/users

HTTPcURLJavaScriptPython

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

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": []
}

Create a organization user

post

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users

Create a organization user by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Body

application/json

userall ofRequired

stringOptional

and

anyOptional

The user id

and

stringOptional

The MongoDB ID

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

Responses

201

Created

application/json

Responseall of

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/organizations/{organizationId}/users

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "user": "63ea10b94a472e003305232b",
  "roles": [
    "text",
    null,
    "63ea10b94a472e003305232b"
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "organization": "63ea10b94a472e003305232b",
  "roles": [
    {
      "_id": "63ea10b94a472e003305232b",
      "name": "Presentation",
      "description": "Presentation role",
      "organization": {
        "_id": "63ea10b94a472e003305232b",
        "name": "Akinon",
        "slug": "hello-world",
        "description": "Akinon is a software company",
        "owner": "63ea10b94a472e003305232b",
        "isExecutive": false,
        "status": 1,
        "privileges": [
          "project:read",
          "project:write"
        ],
        "imageUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
        "createdAt": "2020-07-23T12:00:00.000Z",
        "updatedAt": "2020-07-23T12:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    },
    {
      "organization": "63ea10b94a472e003305232b"
    }
  ]
}

Search organizations users

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users/search/availables

Search organizations users by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

Query parameters

textstringOptional

The text to search

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/users/search/availables

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/users/search/availables HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": []
}

Get a organization user

get

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users/{userId}

Get a organization user by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

userIdstringRequired

The MongoDB ID

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

Responses

200

OK

application/json

Responseall of

and

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/organizations/{organizationId}/users/{userId}

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z",
  "roles": []
}

Update a organization user

put

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users/{userId}

Update a organization user by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

userIdstringRequired

The MongoDB ID

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

Body

application/json

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

/organizations/{organizationId}/users/{userId}

HTTPcURLJavaScriptPython

PUT /api/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "roles": [
    "text",
    null,
    "63ea10b94a472e003305232b"
  ]
}

{
  "_id": "63ea10b94a472e003305232b",
  "username": "[email protected]",
  "language": "en",
  "region": "us",
  "firstName": "John",
  "lastName": "Doe",
  "status": 1,
  "attributes": {
    "iamUserId": "1234567890"
  },
  "avatarUrl": "text",
  "settings": {
    "mailOnBuildCompleted": true,
    "mailOnCodePushCompleted": true
  },
  "lastLoginAt": "2020-07-23T12:00:00.000Z",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Delete a organization user

delete

https://abp-api.akinon.net/apihttps://abptest-api.akinon.net/apihttp://localhost:5001/api

/organizations/{organizationId}/users/{userId}

Delete a organization user by organization user

Authorizations

bearerAuthaccessToken

Path parameters

organizationIdstringRequired

The MongoDB ID

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

userIdstringRequired

The MongoDB ID

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

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

delete

/organizations/{organizationId}/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content