API نکست‌کلاد

GET /api/v1/apps/nextcloud/sites #

List your Nextcloud sites

دسترسی لازم: nextcloud:read محدودیت نرخ: خواندن

پاسخ‌ها (۴)

200 All sites on your account (not paginated) data[]: uuiddomaindomain_typesizeadmin_usernameadmin_emailnc_versionphp_versionstatusfailurebucket_idcreated_at
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:read (details.required_scope)
429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

نمونهٔ curl

curl

curl \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites"

بازگشت به فهرست این بخش

POST /api/v1/apps/nextcloud/sites #

Create a managed Nextcloud site

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

فیلدهای بدنه (JSON) (۴)

size string: الزامی one of: starter | standard | plus | enterprise
domain string: الزامی Full domain you own (contains a dot, e.g. shop.example.com) or a free platform subdomain label without dots: 4-32 chars, ^[a-z0-9][a-z0-9-]{2,30}[a-z0-9]$. Must not be in use.
admin_email string: الزامی
admin_username string: اختیاری Optional, default "admin" — pattern ^[A-Za-z0-9_]{3,60}$

نمونهٔ بدنهٔ درخواست (JSON)

application/json

{
    "size": "starter",
    "domain": "mycloud",
    "admin_email": "admin@example.com",
    "admin_username": "siteadmin"
}

پاسخ‌ها (۶)

200 Site accepted; status starts at creating and moves to running when installation finishes. The first hour is charged to the wallet. data: uuiddomaindomain_typesizeadmin_usernameadmin_emailnc_versionphp_versionstatusfailurebucket_idcreated_at
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
422 validation_failed — details.fields.create: invalid size, invalid admin email, domain required/invalid/already in use, invalid admin username, or insufficient wallet balance
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — provisioning could not start; any charge is refunded. Retry later.

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"size":"starter","domain":"mycloud","admin_email":"admin@example.com","admin_username":"siteadmin"}' \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites"

بازگشت به فهرست این بخش

GET /api/v1/apps/nextcloud/sites/{uuid} #

Get a Nextcloud site with its installed apps

دسترسی لازم: nextcloud:read محدودیت نرخ: خواندن

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۵)

200 Site detail plus apps data: siteapps
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:read (details.required_scope)
404 not_found — no such site on your account
429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

نمونهٔ curl

curl

curl \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID"

بازگشت به فهرست این بخش

DELETE /api/v1/apps/nextcloud/sites/{uuid} #

Delete a Nextcloud site (server, database and site data are destroyed)

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۶)

200 Deleted data: destroyed
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
404 not_found — no such site on your account
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
500 internal_error — unexpected failure; send the request_id to support

نمونهٔ curl

curl

curl -X DELETE \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID"

بازگشت به فهرست این بخش

GET /api/v1/apps/nextcloud/sites/{uuid}/apps #

List installed apps

دسترسی لازم: nextcloud:read محدودیت نرخ: خواندن

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۵)

200 Installed apps (not paginated) data[]: slugversionenabledinstalled_at
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:read (details.required_scope)
404 not_found — no such site on your account, or the site is not running yet
429 rate_limited — read limit reached; wait Retry-After seconds (details.retry_after_sec)

نمونهٔ curl

curl

curl \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/apps"

بازگشت به فهرست این بخش

POST /api/v1/apps/nextcloud/sites/{uuid}/apps #

Install app by slug

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

فیلدهای بدنه (JSON) (۱)

slug string: الزامی App slug: [a-z0-9_]{1,80}; install validates ^[a-z0-9_][a-z0-9_]{1,79}$

نمونهٔ بدنهٔ درخواست (JSON)

application/json

{
    "slug": "calendar"
}

پاسخ‌ها (۷)

200 App installed data: slugversionenabledinstalled_at
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
404 not_found — no such site on your account, or the site is not running yet
422 validation_failed — details.fields.slug: missing or invalid slug
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — install failed on the site; retry later

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"slug":"calendar"}' \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/apps"

بازگشت به فهرست این بخش

DELETE /api/v1/apps/nextcloud/sites/{uuid}/apps/{slug} #

Disable an app

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۲)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])
slug string: الزامی App slug [a-z0-9_]{1,80}; install validates ^[a-z0-9_][a-z0-9_]{1,79}$

پاسخ‌ها (۷)

200 Disabled data: disabled
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
404 not_found — no such site on your account, or the site is not running yet
422 validation_failed — details.fields.slug: invalid slug
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — operation failed on the site; retry later

نمونهٔ curl

curl

curl -X DELETE \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/apps/YOUR_SLUG"

بازگشت به فهرست این بخش

POST /api/v1/apps/nextcloud/sites/{uuid}/admin-password #

Rotate the Nextcloud admin password (new password returned once)

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۶)

200 New random password — shown only in this response data: usernamenew_password
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
404 not_found — no such site on your account, or the site is not running yet
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — rotation failed; the old password stays valid

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/admin-password"

بازگشت به فهرست این بخش

POST /api/v1/apps/nextcloud/sites/{uuid}/refresh-cache #

Purge the Nextcloud cache

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۶)

200 Cache purged data: purged
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
404 not_found — no such site on your account, or the site is not running yet
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — purge failed; retry later

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/refresh-cache"

بازگشت به فهرست این بخش

POST /api/v1/apps/nextcloud/sites/{uuid}/s3 #

Create a private object-storage bucket for this site and return its credentials once

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۶)

200 Bucket created with a read-write key limited to it; configure your upload plugin with these values data: bucket_nameaccess_keysecret_key
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
422 validation_failed — details.fields.s3: site not found, or a bucket is already attached
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — bucket could not be created; retry later

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/s3"

بازگشت به فهرست این بخش

DELETE /api/v1/apps/nextcloud/sites/{uuid}/s3 #

Detach and DELETE the site's bucket, including all files in it

دسترسی لازم: nextcloud:write محدودیت نرخ: تغییر

پارامترهای مسیر (۱)

uuid string: الزامی Nextcloud site UUID (36 chars, [0-9a-f-])

پاسخ‌ها (۶)

200 Bucket and its contents deleted; uploads that still use it will fail data: detached
401 unauthenticated — Authorization header missing or not "Bearer …"; token_invalid — token unknown, expired, revoked or the account is not active
403 scope_missing — the token lacks nextcloud:write (details.required_scope)
422 validation_failed — details.fields.s3: site not found, or no bucket attached
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — bucket could not be deleted; retry later

نمونهٔ curl

curl

curl -X DELETE \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  "https://iranclaud.ir/api/v1/apps/nextcloud/sites/YOUR_UUID/s3"

بازگشت به فهرست این بخش

محصولات

پشتیبانی

List your Nextcloud sites

Create a managed Nextcloud site

Get a Nextcloud site with its installed apps

Delete a Nextcloud site (server, database and site data are destroyed)

List installed apps

Install app by slug

Disable an app

Rotate the Nextcloud admin password (new password returned once)

Purge the Nextcloud cache

Create a private object-storage bucket for this site and return its credentials once

Detach and DELETE the site's bucket, including all files in it