Dependency Management

Operations related to dependency management.

Get a organization dependency

get

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

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

Get a organization dependency by admin

Authorizations

bearerAuthaccessToken

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}$

Responses

200

OK

application/json

isPrivatebooleanRequired

Dependency is private

readmestringRequired

Dependency readme

isVisiblebooleanRequired

Dependency is visible

_idstringRead-onlyRequired

Entity ID

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

namestring · min: 2 · max: 100Required

Dependency name

organizationstringRequired

Organization id

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "isPrivate": true,
  "readme": "text",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "text",
  "organization": "text",
  "createdAt": "2026-03-09T17:38:22.882Z",
  "updatedAt": "2026-03-09T17:38:22.882Z"
}

Update a organization dependency

patch

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

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

Update a organization dependency by admin

Authorizations

bearerAuthaccessToken

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

application/json

isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>

imageUrlstringOptional

Dependency image URL

Responses

200

OK

application/json

isPrivatebooleanRequired

Dependency is private

readmestringRequired

Dependency readme

isVisiblebooleanRequired

Dependency is visible

_idstringRead-onlyRequired

Entity ID

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

namestring · min: 2 · max: 100Required

Dependency name

organizationstringRequired

Organization id

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "isPrivate": "<isPrivate>",
  "imageUrl": "text"
}

{
  "isPrivate": true,
  "readme": "text",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "text",
  "organization": "text",
  "createdAt": "2026-03-09T17:38:22.882Z",
  "updatedAt": "2026-03-09T17:38:22.882Z"
}

Get organization dependencies

get

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

/organizations/{organizationId}/dependencies

Get organization dependencies by admin

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

Query parameters

limitintegerOptional

The limit of per page

Default: 10

pageintegerOptional

Current page number

Default: 1

sortstringOptional

Sort

Example: {"value":"createdAt"}

textstringOptional

Text

isPrivatebooleanOptional

The is private to filter

Responses

200

OK

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get

/organizations/{organizationId}/dependencies

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organizationId}/dependencies 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": [
    {
      "isPrivate": true,
      "readme": "text",
      "isVisible": true,
      "_id": "63ea10b94a472e003305232b",
      "name": "text",
      "organization": "text",
      "createdAt": "2026-03-09T17:38:22.882Z",
      "updatedAt": "2026-03-09T17:38:22.882Z"
    }
  ]
}

Create a organization dependency

post

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

/organizations/{organizationId}/dependencies

Create a organization dependency by admin

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

Entity ID

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

Body

application/json

namestring · min: 3 · max: 255Required

Dependency name

Example: <name>

readmestring · max: 1000Optional

Dependency readme

Example: <readme>

isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/organizations/{organizationId}/dependencies

HTTPcURLJavaScriptPython

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

{
  "name": "<name>",
  "readme": "<readme>",
  "isPrivate": "<isPrivate>"
}

{
  "isPrivate": true,
  "readme": "text",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "text",
  "organization": "text",
  "createdAt": "2026-03-09T17:38:22.882Z",
  "updatedAt": "2026-03-09T17:38:22.882Z"
}

Search dependencies

get

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

/public/dependencies/search

Search dependencies by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

namestringOptional

Dependency name

versionstringOptional

Dependency package version

Responses

200

OK

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

401

Unauthorized

application/json

403

Forbidden

application/json

get

/public/dependencies/search

HTTPcURLJavaScriptPython

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

{
  "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-03-09T17:38:22.882Z",
  "updatedAt": "2026-03-09T17:38:22.882Z"
}

Check updates

get

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

/public/dependencies/check-updates/{dependencyName}

Check updates by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dependencyNamestringRequired

Dependency name

Query parameters

versionstringOptional

Dependency package version

Responses

200

OK

application/json

currentVersionstringRequired

Current version

assetUrlstringOptional

Asset s3 url

newVersionAssetUrlstringOptional

New version asset s3 url

isUpdateAvailablebooleanRequired

Update is available

401

Unauthorized

application/json

403

Forbidden

application/json

get

/public/dependencies/check-updates/{dependencyName}

HTTPcURLJavaScriptPython

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

{
  "currentVersion": "text",
  "assetUrl": "text",
  "newVersionAssetUrl": "text",
  "isUpdateAvailable": true
}

Get a dependency

get

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

/public/dependencies/{dependencyId}

Get a dependency by organization user

Authorizations

bearerAuthaccessToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dependencyIdstringRequired

Entity ID

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

Responses

200

OK

application/json

isPrivatebooleanRequired

Dependency is private

readmestringRequired

Dependency readme

isVisiblebooleanRequired

Dependency is visible

_idstringRead-onlyRequired

Entity ID

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

namestring · min: 2 · max: 100Required

Dependency name

organizationstringRequired

Organization id

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/public/dependencies/{dependencyId}

HTTPcURLJavaScriptPython

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

{
  "isPrivate": true,
  "readme": "text",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "text",
  "organization": "text",
  "createdAt": "2026-03-09T17:38:22.882Z",
  "updatedAt": "2026-03-09T17:38:22.882Z"
}