Packages

Manage dependency packages and versions.

Get organization dependency packages

get

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

Get organization dependency packages by admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

dependencyIdstringRequired

Entity ID

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

Query parameters

versionNumberstringOptional

Version number

envVersionNumberstringOptional

Env version number

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

Current page number

Default: 1

sortstringOptional

Sort

Example: {"value":"createdAt"}

Responses

200

application/json

totalDocsintegerRequired

The total number of users

limitintegerRequired

The limit of users per page

Default: 10

pageintegerRequired

Current page

Default: 1

totalPagesintegerRequired

The total number of pages

pagingCounterintegerRequired

Current page number

hasPrevPagebooleanRequired

Has previous page

hasNextPagebooleanRequired

Has next page

prevPageintegerRequired

Previous page number

nextPageintegerRequired

Next page number

401

Unauthorized

application/json

403

Forbidden

application/json

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

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

{
  "totalDocs": 1,
  "limit": 10,
  "page": 1,
  "totalPages": 1,
  "pagingCounter": 1,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 1,
  "docs": [
    {
      "assetUrl": "text",
      "isPrivate": true,
      "readme": "text",
      "_id": "63ea10b94a472e003305232b",
      "versionNumber": "text",
      "publisher": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "text",
        "lastName": "text"
      },
      "dependency": "63ea10b94a472e003305232b",
      "checksum": "text",
      "rank": 1,
      "envVersionNumber": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a organization dependency package

post

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

Create a organization dependency package by admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

dependencyIdstringRequired

Entity ID

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

Body

namestringRequired

Dependency package name, formatted as -.tgz

Example: test-plugin-1.0.0.tgz

versionNumberstringRequired

Dependency package version number

Example: <versionNumber>

envVersionstringRequired

Dependency package env version

Example: <envVersion>

urlstringRequired

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

Dependency package checksum

Example: <checksum>

isPrivatebooleanOptional

Dependency package is private

Example: <isPrivate>

readmestringOptional

Dependency package readme

Example: <readme>

Responses

201

Created

application/json

assetUrlstringRequired

Dependency package asset URL

isPrivatebooleanRequired

Dependency package is private

readmestringRequired

Dependency package readme

_idstringRead-onlyRequired

Entity ID

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

versionNumberstring · min: 5 · max: 20Required

Dependency package version number

dependencystringRead-onlyRequired

Entity ID

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

checksumstringRequired

Dependency package checksum

rankintegerRequired

Dependency package rank

envVersionNumberstring · min: 5 · max: 20Required

Dependency package env version number

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

400

Bad Request

application/json

401

Unauthorized

application/json

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

POST /api/v1/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: 289

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

{
  "assetUrl": "text",
  "isPrivate": true,
  "readme": "text",
  "_id": "63ea10b94a472e003305232b",
  "versionNumber": "text",
  "publisher": {
    "_id": "63ea10b94a472e003305232b",
    "firstName": "text",
    "lastName": "text"
  },
  "dependency": "63ea10b94a472e003305232b",
  "checksum": "text",
  "rank": 1,
  "envVersionNumber": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete a organization dependency package

delete

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

Delete a organization dependency package by organization user

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

dependencyIdstringRequired

Entity ID

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

packageIdstringRequired

Entity ID

Pattern: ^[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}

DELETE /api/v1/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

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

Get a organization dependency package signed package url by admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

dependencyIdstringRequired

Entity ID

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

packageIdstringRequired

Entity ID

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

Query parameters

urlstringRequired

Url

fileNamestringOptional

File name

Responses

201

application/json

urlstringRequired

Signed URL

401

Unauthorized

application/json

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

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

{
  "url": "text"
}

Get dependency packages

get

/public/dependencies/{dependencyId}/packages

Get dependency packages by organization user

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dependencyIdstringRequired

Entity ID

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

Query parameters

versionNumberstringOptional

Version number

envVersionNumberstringOptional

Env version number

Responses

200

application/json

totalDocsintegerRequired

The total number of users

limitintegerRequired

The limit of users per page

Default: 10

pageintegerRequired

Current page

Default: 1

totalPagesintegerRequired

The total number of pages

pagingCounterintegerRequired

Current page number

hasPrevPagebooleanRequired

Has previous page

hasNextPagebooleanRequired

Has next page

prevPageintegerRequired

Previous page number

nextPageintegerRequired

Next page number

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get/public/dependencies/{dependencyId}/packages

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

{
  "totalDocs": 1,
  "limit": 10,
  "page": 1,
  "totalPages": 1,
  "pagingCounter": 1,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 1,
  "docs": [
    {
      "assetUrl": "text",
      "isPrivate": true,
      "readme": "text",
      "_id": "63ea10b94a472e003305232b",
      "versionNumber": "text",
      "publisher": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "text",
        "lastName": "text"
      },
      "dependency": "63ea10b94a472e003305232b",
      "checksum": "text",
      "rank": 1,
      "envVersionNumber": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

PreviousDependency Management NextBuild Service

Last updated 9 months ago

Was this helpful?