Stop site proxy order

Ends an order with its manage_secret. Final: the site is not served any more within a minute, and nothing is refunded. To change the website or the domain: Stop and Create again.

curl -X POST https://app.apiton.org/v2.SiteProxy/Stop -H 'Content-Type: application/json' \
  -d '{"id":"7k3qx9zd2m","manage_secret":"pxs_9f2c…"}'

The answer is the order: status stopped, status_reason stopped_by_user.

Errors: permission_denied (403) — a wrong secret · failed_precondition (400) — a blocked or already closed order · not_found (404) — no such order · unavailable (503).

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "order": {
        "id": "string",
        "domain": "string",
        "host": "string",
        "root_path": "string",
        "status": "string",
        "status_reason": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "web_proof": {
            "token": "string",
            "value": "string",
            "file_url": "string",
            "txt_name": "string",
            "method": "string",
            "verified_at": "2019-08-24T14:15:22.123Z",
            "checked_at": "2019-08-24T14:15:22.123Z",
            "last_error": "string",
            "fails": 0,
            "next_verify_at": "2019-08-24T14:15:22.123Z"
        },
        "record": {
            "kind": "string",
            "address": "string",
            "points_to_us": true,
            "checked_at": "2019-08-24T14:15:22.123Z"
        },
        "owner": {
            "address": "string",
            "state": "string",
            "checked_at": "2019-08-24T14:15:22.123Z"
        },
        "pay": {
            "periods": 0,
            "amount_nano": "string",
            "first": true,
            "messages": [
                {
                    "kind": "string",
                    "address": "string",
                    "amount_nano": "string",
                    "payload_b64": "string",
                    "comment": "string"
                }
            ],
            "comment": "string",
            "pay_address": "string",
            "ton_link": "string",
            "tonkeeper_link": "string"
        },
        "paid_at": "2019-08-24T14:15:22.123Z",
        "paid_until": "2019-08-24T14:15:22.123Z",
        "activated_at": "2019-08-24T14:15:22.123Z",
        "closed_at": "2019-08-24T14:15:22.123Z",
        "usage": {
            "bytes": "string",
            "requests": "string",
            "quota_bytes": "string",
            "since": "2019-08-24T14:15:22.123Z",
            "over_quota": true
        },
        "ton_url": "string",
        "kind": "string"
    }
}

🔴500Server Error