AppMaker API - OAS 3.0

Get a public presigned URL

get
/upload/presign/public

Get a public presigned URL

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

File name

bucketstringOptional

The base directory name to upload the file

Default: temp
paramsstringOptional

The params for the file upload

Responses
chevron-right
200

OK

application/json
urlstringRequired

Presigned URL

get
/upload/presign/public
200

OK

Get a private presigned URL

get
/upload/presign/private

Get a private presigned URL

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

File name

bucketstringOptional

The base directory name to upload the file

Default: temp
paramsstringOptional

The params for the file upload

Responses
chevron-right
200

OK

application/json
urlstringRequired

Presigned URL

get
/upload/presign/private
200

OK

Get a signed URL

get
/download

Get a signed URL

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

Url

fileNamestringOptional

File name

Responses
chevron-right
200

OK

application/json
urlstringRequired

Signed URL

get
/download

Get changelogs

get
/changelogs

Get changelogs by user

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

The limit of per page

Default: 10
Responses
chevron-right
200

OK

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

get
/changelogs

Get a changelog

get
/changelogs/{changelogId}

Get a changelog by user

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

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
_idstringRead-onlyOptional

Entity ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$
targetVersionstring · min: 5 · max: 20Required

Target version, formatted as semantic version

summarystring · max: 100Required

Changelog summary

markdownstringRequired
rankintegerRead-onlyOptional

Rank for sorting

Default: 0
createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

get
/changelogs/{changelogId}

Get notifications

get
/notifications

Get notifications by user

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

The number of last days to fetch notifications from

sortstringOptional

Sort

Example: {"value":"createdAt"}
limitintegerOptional

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
Responses
chevron-right
200

OK

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

get
/notifications

Get organizations deployments

get
/organizations/{organizationId}/deployments

Get organizations deployments by organization user

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

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

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

get
/organizations/{organizationId}/deployments

Get organizations privileges

get
/organizations/{organizationId}/privileges

Get organizations privileges by organization user

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
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/privileges

Init public multipart upload

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

Init public multipart upload by organization user

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

Entity ID

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

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

OK

application/json
urlsstring[]Optional

Upload urls

BucketstringOptional

File bucket

KeystringOptional

File key

UploadIdstringOptional

Upload Id

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

Init private multipart upload

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

Init private multipart upload by organization user

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

Entity ID

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

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

OK

application/json
urlsstring[]Optional

Upload urls

BucketstringOptional

File bucket

KeystringOptional

File key

UploadIdstringOptional

Upload Id

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

Complete public multipart upload

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

Complete public multipart upload by organization user

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

Entity ID

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

File key, formatted as .

Example: test.apk
uploadIdstringRequired

Upload id

Example: <uploadId>
Responses
chevron-right
200

OK

application/json
BucketstringOptional

File bucket

ETagstringOptional

File ETag

KeystringOptional

File key

LocationstringOptional

File location

Example: https://examplebucket.s3.<Region>.amazonaws.com/bigobject
put
/organizations/{organizationId}/upload/multipart/complete/public

Complete private multipart upload

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

Complete private multipart upload by organization user

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

Entity ID

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

File key, formatted as .

Example: test.apk
uploadIdstringRequired

Upload id

Example: <uploadId>
Responses
chevron-right
200

OK

application/json
BucketstringOptional

File bucket

ETagstringOptional

File ETag

KeystringOptional

File key

LocationstringOptional

File location

Example: https://examplebucket.s3.<Region>.amazonaws.com/bigobject
put
/organizations/{organizationId}/upload/multipart/complete/private

Get a public presigned URL

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

Get a public presigned URL

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

Entity ID

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

File name

bucketstringOptional

The base directory name to upload the file

Default: temp
paramsstringOptional

The params for the file upload

Responses
chevron-right
200

OK

application/json
urlstringRequired

Presigned URL

get
/organizations/{organizationId}/upload/presign/public
200

OK

Get a private presigned URL

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

Get a private presigned URL

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

Entity ID

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

File name

bucketstringOptional

The base directory name to upload the file

Default: temp
paramsstringOptional

The params for the file upload

Responses
chevron-right
200

OK

application/json
urlstringRequired

Presigned URL

get
/organizations/{organizationId}/upload/presign/private
200

OK

Create a ticket for help center

post
/organizations/{organizationId}/help-center/feedback/{type}

Create a ticket for help center by organization user

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

Entity ID

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

The type

Possible values:
Body
messagestringRequired

The ticket message

Example: This is a ticket message
filesstring[]Optional

The s3 file url

Example: https://example.com/attachment.png
Responses
post
/organizations/{organizationId}/help-center/feedback/{type}

No content

Get plugins

get
/plugins

Get plugins by organization user

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

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
textstringOptional

Text

organizationstringOptional

Organization ID

Responses
chevron-right
200

OK

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

get
/plugins

Get plugins owners

get
/plugins/owners

Get plugins owners by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

OK

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

get
/plugins/owners

Get a plugin

get
/plugins/{pluginId}

Get a plugin by organization user

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

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
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

get
/plugins/{pluginId}

Get plugin packages

get
/plugins/{dependencyId}/packages

Get plugin 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
limitintegerOptional

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
sortstringOptional

Sort

Example: {"value":"createdAt"}
versionNumberstringOptional

Version number

envVersionNumberstringOptional

Env version number

Responses
chevron-right
200

OK

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

get
/plugins/{dependencyId}/packages

Get a upgrade diff

get
/upgrade-helper/{tag}

Get a upgrade diff

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

The tags to search, formatted as '..'

Example: tag1..tag2
Responses
chevron-right
200

OK

application/json
stringOptional
get
/upgrade-helper/{tag}

Get upgrade versions

get
/upgrade-helper/versions

Get upgrade versions

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

The limit of per page

Default: 10
Responses
chevron-right
200

OK

application/json
object[]Optional
get
/upgrade-helper/versions

Get a file

get
/upgrade-helper/file/{filePath}

Get a file

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

File path

Example: src/v5.3.2/src/pages/homePage/widgets/imageLinkCategoryBanner/index.js
Responses
chevron-right
200

OK

application/json
stringOptional
get
/upgrade-helper/file/{filePath}

Last updated

Was this helpful?