Skip to content

—API

Справочник HTTP API

Всё, что делает панель, делается этими же эндпоинтами. Справочник собирается из схемы OpenAPI, которую отдаёт сам сервис, — не пишется руками и поэтому не расходится с кодом.

Documentation is currently available in Russian only. A translation is planned; in the meantime, write to support from your account — support works in Russian and Uzbek.

Как обращаться

Базовый адрес:
https://epyc.uz
Авторизация:
Authorization: Bearer <токен>
Где взять токен:
панель НастройкиAPI-токены
Ограничение частоты:
100 запросов в минуту, для авторизации — 10, для пополнения — 5

Чего в справочнике нет

Схему ответа объявляют 70 из 105 эндпоинтов. Для остальных ниже перечислены коды ответов, но не форма тела: обработчик возвращает словарь, и схема о нём ничего не знает. Это наш долг, а не особенность — до его закрытия форму ответа надёжнее всего увидеть, сделав запрос.

Интерактивная консоль (Swagger UI) в проде отключена намеренно: она позволяет отправлять запросы, которые тратят деньги, из публичной страницы.

account

  • GET/api/v1/account/api-tokensтокен

    Ответ · элемент api_tokens[]

    created_at
    string
    id
    string
    last_used_at
    string | null
    name
    string
    prefix
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/account/api-tokensтокен

    Create Api Token

    Тело запроса

    name
    string
    обязательный

    Ответ

    created_at
    string
    full_token
    string
    id
    string
    last_used_at
    string | null
    name
    string
    prefix
    string

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/account/api-tokens/{token_id}токен

    Параметры

    token_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • GET/api/v1/account/ssh-keysтокен

    Ответ · элемент ssh_keys[]

    created_at
    string
    fingerprint
    string
    id
    string
    name
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/account/ssh-keysтокен

    Create Ssh Key

    Тело запроса

    name
    string
    обязательный
    public_key
    string
    обязательный

    Ответ

    created_at
    string
    fingerprint
    string
    id
    string
    name
    string

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/account/ssh-keys/{key_id}токен

    Параметры

    key_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • GET/api/v1/account/teamтокен

    Ответ

    invitations
    TeamInvitationResponse[]
    members
    TeamMemberResponse[]

    Ответы

    • 200 Successful Response
  • DELETE/api/v1/account/team/{member_id}токен

    Параметры

    member_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • POST/api/v1/account/team/acceptтокен

    Accept Team Invite

    Параметры

    token
    string
    в строке запроса
    обязательный

    Ответ

    message
    string
    role
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/account/team/inviteтокен

    Invite Team Member

    Тело запроса

    email
    string
    обязательный
    role
    string

    Ответ

    accepted
    boolean
    created_at
    string
    email
    string
    email_sent
    boolean
    expires_at
    string
    id
    string
    invite_token
    string | null
    role
    string

    Ответы

    • 201 Successful Response
    • 422 Validation Error

admin

  • GET/api/v1/admin/feature-flagsтокен

    Ответ

    flags
    object
    note
    string

    Ответы

    • 200 Successful Response
  • PUT/api/v1/admin/feature-flagsтокен

    Тело запроса

    flags
    object
    обязательный

    Ответ

    flags
    object
    note
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/admin/statsтокен

    Ответ

    active_droplets
    integer
    domains
    integer
    droplets
    integer
    spaces
    integer
    total_balance_minor
    integer
    users
    integer

    Ответы

    • 200 Successful Response
  • GET/api/v1/admin/ticketsтокен

    Параметры

    status_filter
    string | null
    в строке запроса

    Ответ · элемент tickets[]

    created_at
    string
    id
    string
    priority
    string
    status
    string
    subject
    string
    user_id
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/admin/tickets/{ticket_id}/replyтокен

    Параметры

    ticket_id
    string
    в пути
    обязательный

    Тело запроса

    body
    string
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/admin/usersтокен

    Параметры

    search
    string | null
    в строке запроса
    Case-insensitive email substring.
    page
    integer
    в строке запроса
    page_size
    integer
    в строке запроса

    Ответ

    page
    integer
    page_size
    integer
    total
    integer
    users
    AdminUserSummary[]

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/admin/users/{user_id}токен

    Get User Detail

    Параметры

    user_id
    string
    в пути
    обязательный

    Ответ

    balance_minor
    integer
    created_at
    string
    currency
    string | null
    email
    string
    full_name
    string
    id
    string
    is_active
    boolean
    is_admin
    boolean
    is_verified
    boolean
    language
    string
    totp_enabled
    boolean
    updated_at
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/admin/users/{user_id}/adjust-balanceтокен

    Параметры

    user_id
    string
    в пути
    обязательный

    Тело запроса

    amount_minor
    integer
    обязательный
    Signed delta in cents; positive credits, negative debits. Non-zero.
    reason
    string
    обязательный

    Ответ

    amount_minor
    integer
    new_balance_minor
    integer
    previous_balance_minor
    integer
    reason
    string
    transaction_id
    string
    user_id
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error

auth

  • POST/api/v1/auth/2fa/disableтокен

    Параметры

    code
    string
    в строке запроса
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/2fa/enableтокен

    Параметры

    code
    string
    в строке запроса
    обязательный
    secret
    string
    в строке запроса
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/2fa/setupтокен

    Ответ

    qr_uri
    string
    secret
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/auth/accept-termsтокен

    Тело запроса

    accept_terms
    boolean
    version
    string

    Ответ

    created_at
    string
    email
    string
    full_name
    string
    id
    string
    is_admin
    boolean
    is_verified
    boolean
    language
    string
    terms_accepted
    boolean
    terms_version_required
    string
    totp_enabled
    boolean

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/change-passwordтокен

    Тело запроса

    current_password
    string
    обязательный
    new_password
    string
    обязательный

    Ответ

    status
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/forgot-passwordбез токена

    Тело запроса

    email
    string
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/loginбез токена

    Тело запроса

    email
    string (email)
    обязательный
    password
    string
    обязательный
    totp_code
    string | null

    Ответ

    access_token
    string
    token_type
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/logoutбез токена

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
  • GET/api/v1/auth/meтокен

    Ответ

    created_at
    string
    email
    string
    full_name
    string
    id
    string
    is_admin
    boolean
    is_verified
    boolean
    language
    string
    terms_accepted
    boolean
    terms_version_required
    string
    totp_enabled
    boolean

    Ответы

    • 200 Successful Response
  • PATCH/api/v1/auth/meтокен

    Параметры

    full_name
    string | null
    в строке запроса
    language
    string | null
    в строке запроса

    Ответ

    created_at
    string
    email
    string
    full_name
    string
    id
    string
    is_admin
    boolean
    is_verified
    boolean
    language
    string
    terms_accepted
    boolean
    terms_version_required
    string
    totp_enabled
    boolean

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/refreshбез токена

    Ответ

    access_token
    string
    token_type
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/auth/registerбез токена

    Тело запроса

    accept_terms
    boolean
    email
    string (email)
    обязательный
    full_name
    string
    обязательный
    language
    string | null
    password
    string
    обязательный

    Ответ

    created_at
    string
    email
    string
    full_name
    string
    id
    string
    is_admin
    boolean
    is_verified
    boolean
    language
    string
    terms_accepted
    boolean
    terms_version_required
    string
    totp_enabled
    boolean

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/resend-verificationтокен

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/auth/reset-passwordбез токена

    Тело запроса

    new_password
    string
    обязательный
    token
    string
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/auth/verify-emailбез токена

    Параметры

    token
    string
    в строке запроса
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error

billing

  • GET/api/v1/billing/balanceтокен

    Ответ

    auto_topup_amount_minor
    integer
    auto_topup_enabled
    boolean
    auto_topup_method
    string | null
    auto_topup_mode
    string
    auto_topup_threshold_minor
    integer
    balance_display
    string
    balance_minor
    integer
    currency
    string
    hourly_burn_minor
    integer
    hours_remaining
    integer | null
    month_spent_display
    string
    month_spent_minor
    integer
    total_topup_display
    string
    total_topup_minor
    integer

    Ответы

    • 200 Successful Response
  • GET/api/v1/billing/invoicesтокен

    Ответ · элемент invoices[]

    amount_display
    string
    amount_minor
    integer
    created_at
    string
    currency
    string
    due_date
    string
    id
    string
    number
    string
    paid_at
    string | null
    status
    string
    subtotal_minor
    integer
    vat_minor
    integer
    vat_percent
    number

    Ответы

    • 200 Successful Response
  • GET/api/v1/billing/invoices/{invoice_id}/pdfтокен

    Download Invoice Pdf

    Параметры

    invoice_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/billing/promo/redeemтокен

    Тело запроса

    code
    string
    обязательный

    Ответ

    amount_display
    string
    amount_minor
    integer
    balance_display
    string
    balance_minor
    integer
    code
    string
    status
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/billing/topupтокен

    Initiate Topup

    Тело запроса

    amount_minor
    integer
    обязательный
    method
    string
    обязательный

    Ответ

    amount_display
    string
    amount_minor
    integer
    method
    string
    payment_url
    string
    status
    string
    transaction_id
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/billing/transactionsтокен

    Параметры

    limit
    integer
    в строке запроса

    Ответ · элемент transactions[]

    amount_display
    string
    amount_minor
    integer
    created_at
    string
    currency
    string
    description
    string | null
    fx_rate
    number | null
    id
    string
    method
    string | null
    original_amount_minor
    integer | null
    original_currency
    string | null
    status
    string
    type
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/billing/webhooks/clickбез токена

    Click Webhook

    Тело запроса

    action
    integer
    обязательный
    amount
    number
    обязательный
    click_paydoc_id
    integer
    обязательный
    click_trans_id
    integer
    обязательный
    error
    integer
    обязательный
    error_note
    string
    обязательный
    merchant_trans_id
    string
    обязательный
    service_id
    integer
    обязательный
    sign_string
    string
    обязательный
    sign_time
    string
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/billing/webhooks/coingateбез токена

    Coingate Webhook

    Ответы

    • 200 Successful Response
  • POST/api/v1/billing/webhooks/paymeбез токена

    Payme Webhook

    Ответы

    • 200 Successful Response
  • POST/api/v1/billing/webhooks/paypalбез токена

    Paypal Webhook

    Ответы

    • 200 Successful Response

domains

  • GET/api/v1/domainsтокен

    Ответ · элемент domains[]

    created_at
    string
    id
    string
    name
    string
    status
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/domainsтокен

    Create Domain

    Тело запроса

    name
    string
    обязательный

    Ответ

    domain
    DomainItem

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/domains/{domain_id}токен

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответ

    domain
    DomainItem

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/domains/{domain_id}токен

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • POST/api/v1/domains/{domain_id}/dnssec/disableтокен

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/domains/{domain_id}/dnssec/enableтокен

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/domains/{domain_id}/exportтокен

    Export Zone

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/domains/{domain_id}/importтокен

    Import Zone

    Параметры

    domain_id
    string
    в пути
    обязательный
    zone_data
    string
    в строке запроса
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/domains/{domain_id}/recordsтокен

    Параметры

    domain_id
    string
    в пути
    обязательный

    Ответ · элемент records[]

    content
    string
    created_at
    string
    id
    string
    name
    string
    priority
    integer | null
    ttl
    integer
    type
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/domains/{domain_id}/recordsтокен

    Create Record

    Параметры

    domain_id
    string
    в пути
    обязательный

    Тело запроса

    content
    string
    обязательный
    name
    string
    обязательный
    ttl
    integer
    type
    string
    обязательный

    Ответ

    record
    DnsRecordItem

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/domains/{domain_id}/records/{record_id}токен

    Параметры

    domain_id
    string
    в пути
    обязательный
    record_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error

droplets

  • GET/api/v1/dropletsтокен

    Ответ · элемент droplets[]

    backups_enabled
    boolean
    bandwidth_tb
    integer
    created_at
    string
    disk_gb
    integer
    hostname
    string
    id
    string
    image
    string
    ipv4
    string | null
    ipv6
    string | null
    name
    string
    plan
    string
    price_monthly_minor
    integer
    ram_mb
    integer
    region
    string
    status
    string
    vcpu
    integer

    Ответы

    • 200 Successful Response
  • POST/api/v1/dropletsтокен

    Create Droplet

    Тело запроса

    backups_enabled
    boolean
    image
    string
    обязательный
    name
    string
    обязательный
    plan
    string
    обязательный
    region
    string
    ssh_key_ids
    string[]
    user_data
    string | null

    Ответ

    droplet
    DropletItem

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/droplets/{droplet_id}токен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответ

    droplet
    DropletItem

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/droplets/{droplet_id}токен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • POST/api/v1/droplets/{droplet_id}/actionsтокен

    Droplet Action

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Тело запроса

    type
    string
    обязательный

    Ответ

    action
    DropletActionStatus

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/droplets/{droplet_id}/consoleтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответ

    console_url
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/droplets/{droplet_id}/metricsтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответ

    available
    boolean
    metrics
    object
    reason
    string | null

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/droplets/{droplet_id}/metrics-ticketтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответ

    expires_in
    integer
    ticket
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/droplets/{droplet_id}/rebuildтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный
    image
    string
    в строке запроса
    обязательный

    Ответ

    droplet
    DropletItem
    rebuilding_to
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/droplets/{droplet_id}/resizeтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный
    new_plan
    string
    в строке запроса
    обязательный

    Ответ

    droplet
    DropletItem
    resized_to
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/droplets/{droplet_id}/snapshotsтокен

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Ответ · элемент snapshots[]

    created_at
    string
    id
    string
    name
    string
    size_gb
    integer | null
    status
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/droplets/{droplet_id}/snapshotsтокен

    Create Snapshot

    Параметры

    droplet_id
    string
    в пути
    обязательный

    Тело запроса

    name
    string
    обязательный

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/droplets/catalog/imagesбез токена

    Ответ

    apps
    CatalogAppItem[]
    images
    CatalogImageItem[]

    Ответы

    • 200 Successful Response
  • GET/api/v1/droplets/catalog/plansбез токена

    Ответ · элемент plans[]

    bandwidth_tb
    integer
    disk_gb
    integer
    price_monthly_minor
    integer
    ram_mb
    integer
    slug
    string
    vcpu
    integer

    Ответы

    • 200 Successful Response

firewalls

  • GET/api/v1/firewallsтокен

    Ответ

    enforcement
    FirewallEnforcement
    firewalls
    FirewallWithEnforcement[]

    Ответы

    • 200 Successful Response
  • POST/api/v1/firewallsтокен

    Create Firewall

    Тело запроса

    name
    string
    обязательный

    Ответ

    attached_droplets
    AttachedDroplet[]
    created_at
    string
    droplet_count
    integer
    enforcement
    FirewallEnforcement
    id
    string
    name
    string
    rules
    FirewallRuleResponse[]

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/firewalls/{firewall_id}токен

    Параметры

    firewall_id
    string
    в пути
    обязательный

    Ответ

    attached_droplets
    AttachedDroplet[]
    created_at
    string
    droplet_count
    integer
    enforcement
    FirewallEnforcement
    id
    string
    name
    string
    rules
    FirewallRuleResponse[]

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/firewalls/{firewall_id}токен

    Параметры

    firewall_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • POST/api/v1/firewalls/{firewall_id}/dropletsтокен

    Attach Droplets

    Параметры

    firewall_id
    string
    в пути
    обязательный

    Тело запроса

    droplet_ids
    string[]
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/firewalls/{firewall_id}/droplets/{droplet_id}токен

    Detach Droplet

    Параметры

    firewall_id
    string
    в пути
    обязательный
    droplet_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • POST/api/v1/firewalls/{firewall_id}/rulesтокен

    Add Rule

    Параметры

    firewall_id
    string
    в пути
    обязательный

    Тело запроса

    direction
    string
    обязательный
    port_range
    string | null
    protocol
    string
    обязательный
    source
    string

    Ответ

    direction
    string
    id
    string
    port_range
    string | null
    protocol
    string
    source
    string

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/firewalls/{firewall_id}/rules/{rule_id}токен

    Параметры

    firewall_id
    string
    в пути
    обязательный
    rule_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error

notifications

  • GET/api/v1/notificationsтокен

    Параметры

    limit
    integer
    в строке запроса
    unread_only
    boolean
    в строке запроса

    Ответ

    notifications
    NotificationItem[]
    unread_count
    integer

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • PATCH/api/v1/notifications/{notification_id}токен

    Mark Notification Read

    Параметры

    notification_id
    string
    в пути
    обязательный

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/notifications/activityтокен

    Параметры

    limit
    integer
    в строке запроса

    Ответ · элемент activity[]

    action
    string
    created_at
    string
    description
    string
    id
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/notifications/mark-all-readтокен

    Ответы

    • 200 Successful Response
  • GET/api/v1/notifications/preferencesтокен

    Ответ · элемент preferences[]

    email_enabled
    boolean
    event_type
    string
    telegram_enabled
    boolean
    webhook_enabled
    boolean
    webhook_url
    string | null

    Ответы

    • 200 Successful Response
  • PUT/api/v1/notifications/preferencesтокен

    Update Preference

    Тело запроса

    email_enabled
    boolean
    event_type
    string
    обязательный
    telegram_enabled
    boolean
    webhook_enabled
    boolean
    webhook_url
    string | null

    Ответ

    message
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error

observability

  • POST/api/v1/client-errorsбез токена

    Report Client Error

    Тело запроса

    kind
    string
    message
    string
    обязательный
    release
    string | null
    stack
    string | null
    url
    string | null

    Ответы

    • 202 Successful Response
    • 422 Validation Error

other

  • GET/api/healthбез токена

    Ответы

    • 200 Successful Response
  • GET/api/health/celeryбез токена

    Ответы

    • 200 Successful Response
  • GET/api/health/readyбез токена

    Ответы

    • 200 Successful Response

spaces

  • GET/api/v1/spacesтокен

    Ответ · элемент spaces[]

    bucket
    string | null
    created_at
    string
    endpoint
    string | null
    id
    string
    is_public
    boolean
    name
    string
    object_count
    integer
    quota_bytes
    integer
    quota_used_percent
    number | null
    region
    string
    size_bytes
    integer
    usage_synced_at
    string | null

    Ответы

    • 200 Successful Response
  • POST/api/v1/spacesтокен

    Create Space

    Тело запроса

    is_public
    boolean
    name
    string
    обязательный
    region
    string

    Ответ

    space
    SpaceItem

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/spaces/{space_id}токен

    Параметры

    space_id
    string
    в пути
    обязательный

    Ответ

    space
    SpaceItem

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/spaces/{space_id}токен

    Параметры

    space_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • PUT/api/v1/spaces/{space_id}/corsтокен

    Параметры

    space_id
    string
    в пути
    обязательный

    Тело запроса

    origins
    string[]
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • GET/api/v1/spaces/{space_id}/keysтокен

    Параметры

    space_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/spaces/{space_id}/keysтокен

    Create Key

    Параметры

    space_id
    string
    в пути
    обязательный
    name
    string
    в строке запроса
    обязательный

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/spaces/{space_id}/keys/{key_id}токен

    Параметры

    space_id
    string
    в пути
    обязательный
    key_id
    string
    в пути
    обязательный

    Ответы

    • 204 Successful Response
    • 422 Validation Error
  • GET/api/v1/spaces/{space_id}/objectsтокен

    Параметры

    space_id
    string
    в пути
    обязательный
    prefix
    string
    в строке запроса
    delimiter
    string
    в строке запроса
    limit
    integer
    в строке запроса
    continuation_token
    string | null
    в строке запроса

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • DELETE/api/v1/spaces/{space_id}/objectsтокен

    Delete Object

    Параметры

    space_id
    string
    в пути
    обязательный

    Тело запроса

    key
    string
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/spaces/{space_id}/presignedтокен

    Get Presigned Url

    Параметры

    space_id
    string
    в пути
    обязательный

    Тело запроса

    content_length
    integer | null
    expires
    integer
    key
    string
    обязательный
    method
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • PUT/api/v1/spaces/{space_id}/quotaтокен

    Параметры

    space_id
    string
    в пути
    обязательный

    Тело запроса

    quota_bytes
    integer
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/spaces/{space_id}/usage/recalculateтокен

    Параметры

    space_id
    string
    в пути
    обязательный

    Ответы

    • 200 Successful Response
    • 422 Validation Error

status

  • GET/api/v1/statusбез токена

    Ответы

    • 200 Successful Response

tickets

  • GET/api/v1/ticketsтокен

    Ответ · элемент tickets[]

    created_at
    string
    id
    string
    priority
    string
    status
    string
    subject
    string
    updated_at
    string

    Ответы

    • 200 Successful Response
  • POST/api/v1/ticketsтокен

    Create Ticket

    Тело запроса

    body
    string
    обязательный
    priority
    string
    subject
    string
    обязательный

    Ответ

    created_at
    string
    id
    string
    priority
    string
    status
    string
    subject
    string
    updated_at
    string

    Ответы

    • 201 Successful Response
    • 422 Validation Error
  • GET/api/v1/tickets/{ticket_id}токен

    Параметры

    ticket_id
    string
    в пути
    обязательный

    Ответ

    created_at
    string
    id
    string
    messages
    TicketMessageResponse[]
    priority
    string
    status
    string
    subject
    string
    updated_at
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/tickets/{ticket_id}/closeтокен

    Параметры

    ticket_id
    string
    в пути
    обязательный

    Ответ

    created_at
    string
    id
    string
    priority
    string
    status
    string
    subject
    string
    updated_at
    string

    Ответы

    • 200 Successful Response
    • 422 Validation Error
  • POST/api/v1/tickets/{ticket_id}/messagesтокен

    Reply Ticket

    Параметры

    ticket_id
    string
    в пути
    обязательный

    Тело запроса

    body
    string
    обязательный

    Ответ

    body
    string
    created_at
    string
    id
    string
    is_staff
    boolean

    Ответы

    • 201 Successful Response
    • 422 Validation Error

Версия схемы: 1.0.0. Справочник пересобирается вместе с сайтом, а сборка падает, если снимок схемы разошёлся с кодом.