Dependency Management

Operations related to dependency management.

Get a organization dependency

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

Get a organization dependency 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}$
Responses
200

OK

application/json
get
/organizations/{organizationId}/dependencies/{dependencyId}
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": "2025-12-06T08:11:38.447Z",
  "updatedAt": "2025-12-06T08:11:38.447Z"
}

Update a organization dependency

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

Update a organization dependency 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
isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>
imageUrlstringOptional

Dependency image URL

Responses
200

OK

application/json
patch
/organizations/{organizationId}/dependencies/{dependencyId}
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": "2025-12-06T08:11:38.447Z",
  "updatedAt": "2025-12-06T08:11:38.447Z"
}

Get organization dependencies

get
/organizations/{organizationId}/dependencies

Get organization dependencies by admin

Authorizations
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
Responseall of
get
/organizations/{organizationId}/dependencies
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": "2025-12-06T08:11:38.447Z",
      "updatedAt": "2025-12-06T08:11:38.447Z"
    }
  ]
}

Create a organization dependency

post
/organizations/{organizationId}/dependencies

Create a organization dependency by admin

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestring · min: 3 · max: 255Required

Dependency name

Example: <name>
readmestring · max: 1000Optional

Dependency readme

Example: <readme>
isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>
Responses
post
/organizations/{organizationId}/dependencies
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": "2025-12-06T08:11:38.447Z",
  "updatedAt": "2025-12-06T08:11:38.447Z"
}
get
/public/dependencies/search

Search dependencies by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
namestringOptional

Dependency name

versionstringOptional

Dependency package version

Responses
200

OK

application/json
get
/public/dependencies/search
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": "2025-12-06T08:11:38.447Z",
  "updatedAt": "2025-12-06T08:11:38.447Z"
}

Check updates

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

Check updates by organization user

Authorizations
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
get
/public/dependencies/check-updates/{dependencyName}
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
/public/dependencies/{dependencyId}

Get a dependency by organization user

Authorizations
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
get
/public/dependencies/{dependencyId}
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": "2025-12-06T08:11:38.447Z",
  "updatedAt": "2025-12-06T08:11:38.447Z"
}

Last updated

Was this helpful?