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
get
/organizations/{organizationId}/dependencies/{dependencyId}/packages

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
post
/organizations/{organizationId}/dependencies/{dependencyId}/packages

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
chevron-right
204

No Content

No content

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

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
get
/organizations/{organizationId}/dependencies/{dependencyId}/packages/{packageId}/download

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
get
/public/dependencies/{dependencyId}/packages

Last updated

Was this helpful?