API مترموست

GET /api/v1/apps/mattermost/sites #

List your Mattermost sites

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

پاسخ‌ها (۴)

200 All sites on your account (not paginated) data[]: uuiddomaindomain_typesizeadmin_usernameadmin_emailmm_versionstatusfailurecreated_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 mattermost: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/mattermost/sites"

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

POST /api/v1/apps/mattermost/sites #

Create a managed Mattermost site

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

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

size string: الزامی one of: starter | standard | plus
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": "mychat",
    "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_emailmm_versionstatusfailurecreated_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 mattermost: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":"mychat","admin_email":"admin@example.com","admin_username":"siteadmin"}' \
  "https://iranclaud.ir/api/v1/apps/mattermost/sites"

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

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

Get a Mattermost site

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

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

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

پاسخ‌ها (۵)

200 Site detail data: site
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 mattermost: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/mattermost/sites/YOUR_UUID"

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

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

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

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

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

uuid string: الزامی Mattermost 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 mattermost: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/mattermost/sites/YOUR_UUID"

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

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

Rotate the Mattermost admin password (new password returned once)

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

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

uuid string: الزامی Mattermost 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 mattermost: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/mattermost/sites/YOUR_UUID/admin-password"

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

GET /api/v1/apps/mattermost/sites/{uuid}/teams #

List teams

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

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

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

پاسخ‌ها (۶)

200 Teams on the site (not paginated) data[]: idnamedisplay_nametype
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 mattermost: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)
500 internal_error — the site did not answer; retry later

نمونهٔ curl

curl

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

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

POST /api/v1/apps/mattermost/sites/{uuid}/teams #

Create a team

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

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

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

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

name string: الزامی URL name, 3-64 chars, lower-cased before validation, no leading/trailing dash — pattern ^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$
display_name string: الزامی Counted in characters (Persian allowed) — min 1 chars; max 64 chars
type string: اختیاری O = open (default), I = invite-only — one of: O | I

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

application/json

{
    "name": "engineering",
    "display_name": "Engineering",
    "type": "I"
}

پاسخ‌ها (۷)

200 Team created (echoes the input) data: namedisplay_nametype
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 mattermost: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.team: invalid name, display_name or type
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — team could not be created (e.g. name taken); retry or pick another name

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"engineering","display_name":"Engineering","type":"I"}' \
  "https://iranclaud.ir/api/v1/apps/mattermost/sites/YOUR_UUID/teams"

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

GET /api/v1/apps/mattermost/sites/{uuid}/users #

List users

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

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

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

پاسخ‌ها (۶)

200 Users on the site (not paginated) data[]: idusernameemailroles
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 mattermost: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)
500 internal_error — the site did not answer; retry later

نمونهٔ curl

curl

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

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

POST /api/v1/apps/mattermost/sites/{uuid}/users #

Create a user (password returned once)

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

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

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

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

email string: الزامی
username string: الزامی Lower-cased before validation — pattern ^[A-Za-z0-9_]{1,60}$
password string: اختیاری Optional; when omitted a random 16-char password is generated — min 8 chars

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

application/json

{
    "email": "sara@example.com",
    "username": "sara"
}

پاسخ‌ها (۷)

200 User created; the password is shown only in this response data: emailusernamepassword
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 mattermost: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.user: invalid email, username or password
429 rate_limited — write limit reached; wait Retry-After seconds (details.retry_after_sec)
503 backend_error — user could not be created (e.g. email or username taken)

نمونهٔ curl

curl

curl -X POST \
  -H "Authorization: Bearer $IRANCLAUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"sara@example.com","username":"sara"}' \
  "https://iranclaud.ir/api/v1/apps/mattermost/sites/YOUR_UUID/users"

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

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

Reload the Mattermost service to refresh its configuration cache

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

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

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

پاسخ‌ها (۶)

200 Reload triggered data: refreshed
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 mattermost: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 — reload failed; retry later

نمونهٔ curl

curl

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

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

محصولات

پشتیبانی

List your Mattermost sites

Create a managed Mattermost site

Get a Mattermost site

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

Rotate the Mattermost admin password (new password returned once)

List teams

Create a team

List users

Create a user (password returned once)

Reload the Mattermost service to refresh its configuration cache