●توثيق الـAPI · v1

السطح كله، موثّق.

أنشئ توكن وصول شخصي، ضع ترويسة Authorization، وابدأ. كل ما في هذه الصفحة يعمل من أي سكربت أو خادم. الـAPI مجاني، وتدفع فقط مقابل ما تشغّله.

افتح المرجع كملف نصّي واحد للنماذج اللغوية

Base URLhttps://api.evorxa.com/api

ترويسة المصادقةAuthorization: Bearer <token>

حد الطلبات60 طلب/دقيقة لكل توكن

auth

Authentication

Every request authenticates with a personal access token in the Authorization header. Mint a token in your dashboard at /api-tokens. Each token can be scoped to specific abilities (instances:read, agent:write, waf:*, etc.) or granted full access.

GET/meGet the authenticated user

Returns the user record and the projects they belong to, including the caller's role in each project. next_renewal describes the next scheduled charge across the account: when it falls, what it will cost in cents, and how many instances are in it. It is null when nothing is due.

الردود

200User and project list

{
  "user": {
    "id": 42,
    "email": "you@example.com",
    "name": "Jane Operator",
    "wallet_balance": 5240,
    "onboarded": true,
    "next_renewal": { "at": "2026-09-01T00:00:00+00:00", "amount_cents": 8600, "instances": 3 }
  },
  "projects": [
    { "id": 1, "name": "default", "type": "personal", "current_user_role": "owner" }
  ]
}

مثال

curl https://api.evorxa.com/api/me \
  -H "Authorization: Bearer $EVORXA_TOKEN"

PUT/meUpdate your profile

Updates the authenticated user's personal details. All fields are optional; only the fields you send are changed.

الصلاحية المطلوبة

all

جسم الطلب

الاسم	النوع	الوصف
`first_name`	`string`	Optional. First name.
`last_name`	`string`	Optional. Last name.
`phone`	`string`	Optional. Phone number in international format. Send null to clear.
`country`	`string`	Optional. Two-letter country code (ISO 3166-1 alpha-2).

الردود

200Updated user record.

{
  "user": {
    "id": 42,
    "name": "Jane Operator",
    "first_name": "Jane",
    "last_name": "Operator",
    "email": "you@example.com",
    "phone": "+15550001111",
    "country": "US"
  }
}

422Validation failed.

مثال

curl -X PUT https://api.evorxa.com/api/me \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"","last_name":"","phone":"","country":""}'

GET/me/api-tokensList your personal API tokens

الصلاحية المطلوبة

all

الردود

200Token list (without the secret)

[
  {
    "id": 7,
    "name": "CI deployer",
    "abilities": ["instances:read", "instances:write"],
    "last_used_at": "2026-05-14T09:12:03.000Z",
    "created_at": "2026-05-01T18:00:00.000Z"
  }
]

مثال

curl https://api.evorxa.com/api/me/api-tokens \
  -H "Authorization: Bearer $EVORXA_TOKEN"

POST/me/api-tokensMint a new API token

جسم الطلب

الاسم	النوع	الوصف
`name`إلزامي	`string`	Human label for this token.
`abilities`	`string[]`	Optional. Defaults to ["*"] (full access). Use scoped abilities like "instances:read" to limit the token.

الردود

201Token created. The plaintext token is returned only once, so store it now.

{
  "id": 8,
  "name": "CI deployer",
  "abilities": ["instances:read", "instances:write"],
  "token": "8|aB9xKp2QrLm...",
  "created_at": "2026-05-14T19:42:18.000Z"
}

مثال

curl -X POST https://api.evorxa.com/api/me/api-tokens \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"","abilities":[]}'

DELETE/me/api-tokens/{id}Revoke an API token
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Token ID.
الردود
- 204Revoked.
مثال
```
curl -X DELETE https://api.evorxa.com/api/me/api-tokens/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

الاسم	النوع	الوصف
`id`إلزامي	`integer`	Token ID.

team

Team

Projects are shared workspaces. Each member holds a role. Owners can invite teammates, manage members, rename or delete the project, and take billing-impacting actions (create, upgrade, delete, or reactivate instances). Members get read and non-billing access. Invitations go out by email and expire after seven days.

GET/projects/{project}/membersList members and pending invitations

Returns the project's members with their roles plus any pending invitations. Available to every member of the project.

الصلاحية المطلوبة

all

بارامترات المسار

الاسم	النوع	الوصف
`project`إلزامي	`integer`	Project ID.

الردود

200Members and pending invitations.

{
  "project": { "id": 1, "name": "default", "type": "personal" },
  "current_user_role": "owner",
  "members": [
    {
      "id": 3,
      "role": "owner",
      "user": { "id": 42, "name": "Jane Operator", "email": "you@example.com" }
    }
  ],
  "invitations": [
    {
      "id": 9,
      "email": "teammate@example.com",
      "role": "member",
      "expires_at": "2026-06-02T12:00:00.000Z",
      "inviter": { "id": 42, "name": "Jane Operator", "email": "you@example.com" }
    }
  ]
}

404You are not a member of this project.

مثال

curl https://api.evorxa.com/api/projects/{project}/members \
  -H "Authorization: Bearer $EVORXA_TOKEN"

POST/projects/{project}/invitationsInvite a teammate by email

Owner only. Sends an email invitation that the recipient accepts while signed in with the same address. The invitation expires after seven days.

الصلاحية المطلوبة

all

بارامترات المسار

الاسم	النوع	الوصف
`project`إلزامي	`integer`	Project ID.

جسم الطلب

الاسم	النوع	الوصف
`email`إلزامي	`string`	Recipient email address.
`role`	`string`	Optional. "owner" or "member". Defaults to "member".
`locale`	`string`	Optional. One of "en", "ar", "de", "nl", "it". Sets the language of the invitation link. Defaults to "en".

الردود

201Invitation created and emailed.

{
  "id": 9,
  "project_id": 1,
  "email": "teammate@example.com",
  "role": "member",
  "expires_at": "2026-06-02T12:00:00.000Z"
}

403Only project owners can invite teammates.
409An active invitation already exists for that email.
422That user is already a project member.

مثال

curl -X POST https://api.evorxa.com/api/projects/{project}/invitations \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"","role":"","locale":""}'

DELETE/projects/{project}/members/{member}Remove a member
Owner only. Removes a member from the project. A project must always keep at least one owner.
الصلاحية المطلوبة
all
بارامترات المسار
الاسم النوع الوصف
projectإلزامي integer Project ID.
memberإلزامي integer Member record ID, from the members list.
الردود
- 204Member removed.
- 403Only project owners can remove members.
- 422Cannot remove the last remaining owner.
مثال
```
curl -X DELETE https://api.evorxa.com/api/projects/{project}/members/{member} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

PUT/projects/{project}Update project details

Owner only. Updates the project's name and organization details. All fields are optional; only the fields you send are changed.

الصلاحية المطلوبة

all

بارامترات المسار

الاسم	النوع	الوصف
`project`إلزامي	`integer`	Project ID.

جسم الطلب

الاسم	النوع	الوصف
`name`	`string`	Optional. Project / organization name.
`tax_id`	`string`	Optional. Tax or VAT registration number. Send null to clear.
`address`	`string`	Optional. Billing address. Send null to clear.

الردود

200Updated project.

{
  "id": 1,
  "name": "Acme Inc",
  "type": "business",
  "tax_id": "EG-123456789",
  "address": "1 Production Way, Cairo"
}

403Only project owners can update project details.

مثال

curl -X PUT https://api.evorxa.com/api/projects/{project} \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"","tax_id":"","address":""}'

DELETE/projects/{project}/invitations/{invite}Cancel a pending invitation
Owner only. Cancels an invitation that has not been accepted yet.
الصلاحية المطلوبة
all
بارامترات المسار
الاسم النوع الوصف
projectإلزامي integer Project ID.
inviteإلزامي integer Invitation ID.
الردود
- 204Invitation cancelled.
- 403Only project owners can cancel invitations.
- 422Accepted invitations cannot be cancelled.
مثال
```
curl -X DELETE https://api.evorxa.com/api/projects/{project}/invitations/{invite} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

instances

Instances

Provision, list, inspect, power-cycle, reinstall, upgrade, and retire VPS instances. Pricing is debited from the wallet at creation and at upgrade.

GET/instancesList instances

الصلاحية المطلوبة

instances:read

بارامترات الـQuery

الاسم	النوع	الوصف
`project_id`	`integer`	Filter to one project. Defaults to all projects you own.

الردود

200Array of instances.

[
  {
    "id": "01H9...",
    "name": "api-prod-1",
    "hostname": "api-prod-1.server.evorxa.net",
    "plan": "scout-2",
    "status": "running",
    "main_ip": "203.0.113.42",
    "vcpu": 2, "ram": 4, "storage": 60,
    "billed_till": "2026-06-14T00:00:00.000Z",
    "ip_addresses": [...]
  }
]

مثال

curl https://api.evorxa.com/api/instances \
  -H "Authorization: Bearer $EVORXA_TOKEN"

POST/instancesProvision a new instance

Provisions a server on the Evorxa platform, builds the OS, debits the wallet, and returns the new record. The instance starts in 'provisioning' status and transitions to 'running' once the OS boots.

الصلاحية المطلوبة

instances:write

جسم الطلب

الاسم	النوع	الوصف
`name`إلزامي	`string`	Display name, 3-255 characters. Used in hostname derivation.
`hostname`إلزامي	`string`	FQDN. Auto-managed reverse DNS.
`project_id`إلزامي	`integer`	Owning project.
`package_id`إلزامي	`integer`	Plan package ID. See /me/catalog/plans.
`category`إلزامي	`string`	Either "standard" or "cpu-optimized".
`os_template_id`إلزامي	`integer`	From /catalog/os-templates/{packageId}. Not required when app_slug is given, since the app selects its own base image.
`os_name`إلزامي	`string`	Display label for the OS. Not required when app_slug is given.
`billing_cycle`إلزامي	`string`	"monthly", "6months", or "yearly".
`coupon`	`string`	Optional coupon code. The discount is applied to the amount debited; an invalid, expired, or inapplicable code fails the request with 422 rather than charging full price.
`app_slug`	`string`	Optional. Install a one-click application on the new server. See /catalog/apps. Replaces os_template_id and os_name.
`app_password`	`string`	Optional, 8-128 characters. The sign-in password for the application. Omit it and a strong one is generated for you. Ignored by applications that create their own first account.
`app_license_key`	`string`	Required only for applications that cannot install without a licence you already own — those are marked license_required_upfront in /catalog/apps. Sent to the server during installation and never returned.
`ssh_key_ids`	`integer[]`	Optional. SSH keys to inject at build time.

الردود

201Instance created. Status is 'provisioning'.
402Insufficient wallet balance.
422Invalid plan, package, category, coupon, or app, the app does not fit the plan, or the plan is out of stock.

مثال

curl -X POST https://api.evorxa.com/api/instances \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"","hostname":"","project_id":0,"package_id":0,"category":"","os_template_id":0,"os_name":"","billing_cycle":"","coupon":"","app_slug":"","app_password":"","app_license_key":"","ssh_key_ids":[]}'

GET/instances/{id}/appGet the application installed on an instance
The one-click application installed on this server, with its sign-in details. Installation continues in the background after the instance is created, so poll this until status is 'ready'. Answers with a null app when the server was built without one.
الصلاحية المطلوبة
instances:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200The application, or null.
  { "app": { "slug": "wordpress", "name": "WordPress", "status": "ready", "username": "admin", "password": "generated-at-order-time", "login_url": "http://203.0.113.42/wp-admin", "installed_at": "2026-06-14T10:22:41.000Z" } }
مثال
```
curl https://api.evorxa.com/api/instances/{id}/app \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

GET/instances/{id}Get an instance

الصلاحية المطلوبة

instances:read

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`string`	Instance UUID.

الردود

200Instance with live runtime state attached.

{
  "id": "01H9...",
  "name": "api-prod-1",
  "status": "running",
  "vf_state": "complete",
  "vf_remote_state": {
    "state": "running",
    "cpu": 12.4,
    "memory": { "memtotal": 4194304, "memfree": 1572864 }
  }
}

404Instance not found or deleted.

مثال

curl https://api.evorxa.com/api/instances/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"

DELETE/instances/{id}Delete an instance
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
جسم الطلب
الاسم النوع الوصف
modeإلزامي string "immediate" (delete now, prorated refund) or "end_of_cycle" (cancel renewal).
الردود
- 200Deleted, with refund amount in cents.
مثال
```
curl -X DELETE https://api.evorxa.com/api/instances/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":""}'
```
POST/instances/{id}/power/{action}Power action
Boot, shutdown, restart, or hard power-off. Local status moves to a transitional state and syncs from the hypervisor.
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
actionإلزامي string boot · shutdown · restart · poweroff
الردود
- 200Command dispatched.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/power/{action} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/trafficNetwork traffic across every instance
One request for the whole account. Readings are stored every five minutes and summed per bucket, so this is the cheap way to chart bandwidth without asking each instance in turn. Counters are differenced per instance before they are added together, and a reboot that resets a counter contributes nothing rather than a spike.
الصلاحية المطلوبة
analytics:read
بارامترات الـQuery
الاسم النوع الوصف
period string "1h", "6h", "12h", "24h". Default "24h".
الردود
- 200Totals for the window and a continuous series.
  { "period_minutes": 1440, "bucket_minutes": 30, "instances": 4, "totals": { "rx_bytes": 1363148599296, "tx_bytes": 559532441600 }, "points": [ { "t": "2026-08-18T00:00:00+00:00", "rx_bytes": 28374619136, "tx_bytes": 11653201920 } ] }
مثال
```
curl https://api.evorxa.com/api/instances/traffic \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/{id}/metricsCPU / RAM / disk / network
Live snapshot from the hypervisor plus stored history for the requested period.
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
بارامترات الـQuery
الاسم النوع الوصف
period string "5m", "30m", "1h", "6h", "12h", "24h". Default "1h".
الردود
- 200Current snapshot + history points.
  { "current": { "cpu_percent": 12.4, "memory_used_kb": 2621440, "memory_total_kb": 4194304, "disk_used_bytes": 12884901888, "disk_total_bytes": 64424509440, "network_rx_bytes": 938472847, "network_tx_bytes": 271938247 }, "history": [...] }
مثال
```
curl https://api.evorxa.com/api/instances/{id}/metrics \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/upgradeUpgrade plan
Prorates the difference and debits the wallet. Optionally reboots immediately.
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
جسم الطلب
الاسم النوع الوصف
package_idإلزامي integer Target plan package.
rebootإلزامي boolean Reboot immediately to apply.
الردود
- 200Upgraded with prorated charge.
- 402Insufficient wallet balance for the difference.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/upgrade \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"package_id":0,"reboot":false}'
```

الاسم	النوع	الوصف
`mode`إلزامي	`string`	"immediate" (delete now, prorated refund) or "end_of_cycle" (cancel renewal).

الاسم	النوع	الوصف
`period`	`string`	"1h", "6h", "12h", "24h". Default "24h".

الاسم	النوع	الوصف
`period`	`string`	"5m", "30m", "1h", "6h", "12h", "24h". Default "1h".

الاسم	النوع	الوصف
`package_id`إلزامي	`integer`	Target plan package.
`reboot`إلزامي	`boolean`	Reboot immediately to apply.

POST/instances/{id}/reinstallReinstall the OS or an application

Wipes the disk and rebuilds it. Send either an operating system or an application slug — an application brings its own image, so the two are alternatives rather than a pair. The root password is reissued and returned by GET /instances/{id}.

الصلاحية المطلوبة

instances:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`string`	Instance UUID.

جسم الطلب

الاسم	النوع	الوصف
`os_template_id`	`integer`	Required unless app_slug is sent. From /instances/{id}/reinstall-options.
`os_name`	`string`	Required unless app_slug is sent. Display label.
`app_slug`	`string`	Required unless os_template_id is sent. From /catalog/apps. Refused with 422 if the plan is below the application's minimums.
`app_password`	`string`	Optional. Sign-in password for the application. Generated for you when omitted.
`app_license_key`	`string`	Optional. Required up front by applications that validate a licence during setup.

الردود

200Reinstall started. Status moves to 'provisioning'.
422Neither an operating system nor an application was sent, or the plan is too small for the application.

مثال

curl -X POST https://api.evorxa.com/api/instances/{id}/reinstall \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"os_template_id":0,"os_name":"","app_slug":"","app_password":"","app_license_key":""}'

GET/instances/{id}/reinstall-optionsList OS templates for reinstall
الصلاحية المطلوبة
instances:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200OS template groups.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/reinstall-options \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/reset-passwordGenerate a new root/Administrator password
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200New password returned in cleartext (once).
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/reset-password \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/cancel-deletionUndo a scheduled deletion
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Deletion cancelled, billing resumed.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/cancel-deletion \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/extendExtend the billing period early
Debits one billing cycle from the wallet immediately and pushes billed_till forward by that cycle. Clears any scheduled end-of-cycle deletion. Not available while the instance is suspended.
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Extended; new billed_till returned.
- 402Insufficient wallet balance.
- 422Instance suspended or has no renewable cycle.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/extend \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/reactivateReactivate a suspended instance
Debits the cycle cost from the wallet, extends billed_till, and unsuspends the instance.
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Reactivated.
- 402Insufficient wallet balance.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/reactivate \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

ddos

DDoS Protection

Network-layer DDoS protection is always on for supported locations: attacks are detected and scrubbed at the network edge before they reach your server. These endpoints expose the scrubbing analytics (dropped vs passed traffic), the attack history of an instance, and the per-instance attack notification settings. All of them return supported: false when the instance's IP is not on a protected prefix.

GET/instances/{id}/ddos/overviewDropped vs passed traffic series
Time series of scrubbed (dropped) and clean (passed) traffic for the instance's primary IPv4, normalized to bits per second and ordered oldest first. The live period returns roughly 12-second buckets covering the last 10 minutes; longer periods return coarser buckets.
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
بارامترات الـQuery
الاسم النوع الوصف
period string "live", "1h", "1d", "1w". Default "live".
الردود
- 200Traffic points for the period.
  { "supported": true, "period": "live", "points": [ { "time": "2026-08-11T17:12:15Z", "drop_bps": 0, "pass_bps": 470 }, { "time": "2026-08-11T17:12:28Z", "drop_bps": 528000000, "pass_bps": 610 } ], "updated_at": "2026-08-11T17:12:28Z" }
- 502Analytics temporarily unavailable upstream.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/ddos/overview \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/{id}/ddos/incidentsAttack history
Past DDoS attacks against the instance's primary IPv4, newest first. Only attacks that happened after the instance was created are listed.
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
بارامترات الـQuery
الاسم النوع الوصف
page integer Page number, starting at 1.
الردود
- 200Attack list with pagination.
  { "supported": true, "items": [ { "id": 106248, "started_at": "2026-07-12T11:15:28Z", "ended_at": "2026-07-12T11:16:13Z", "duration_seconds": 45, "vectors": ["UDP_FLOOD"], "peak": "771.49 Mbps" } ], "page": 1, "page_size": 10, "total_items": 1, "total_pages": 1, "has_next": false, "has_previous": false }
- 502Analytics temporarily unavailable upstream.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/ddos/incidents \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/{id}/ddos/settingsGet attack notification settings
Attack notification preferences for this instance. Email alerts are enabled by default. The Discord webhook URL is write-only: reads expose only whether one is configured plus its last four characters.
الصلاحية المطلوبة
instances:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Current settings.
  { "email_notifications": true, "discord_webhook_configured": true, "discord_webhook_hint": "a1b2", "affiliate_link_enabled": false, "is_affiliate": true }
مثال
```
curl https://api.evorxa.com/api/instances/{id}/ddos/settings \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

الاسم	النوع	الوصف
`period`	`string`	"live", "1h", "1d", "1w". Default "live".

الاسم	النوع	الوصف
`page`	`integer`	Page number, starting at 1.

PUT/instances/{id}/ddos/settingsUpdate attack notification settings

All fields are optional; only the fields you send are changed. The Discord alert is shareable by design: it shows attack details and a 'Server protected by Evorxa' link, but never your IP address. With affiliate_link_enabled (affiliates only) that link becomes your referral shortlink.

الصلاحية المطلوبة

instances:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`string`	Instance UUID.

جسم الطلب

الاسم	النوع	الوصف
`email_notifications`	`boolean`	Optional. Email the project owner when an attack is mitigated.
`discord_webhook_url`	`string`	Optional. A discord.com/api/webhooks/... URL. Send null to remove.
`affiliate_link_enabled`	`boolean`	Optional. Use your affiliate shortlink in the webhook embed.

الردود

200Updated settings (same shape as GET).
422Webhook URL is not a valid Discord webhook.

مثال

curl -X PUT https://api.evorxa.com/api/instances/{id}/ddos/settings \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email_notifications":false,"discord_webhook_url":"","affiliate_link_enabled":false}'

agent

AI Agent

An LLM-driven operator with SSH into your box and a tool kit (shell, file edit, log tail). Open a chat to an instance and stream the agent's actions back. Every account includes a one-time free usage allowance; once it is spent, usage is billed to your wallet balance — but only after you explicitly enable billing.

GET/agent/creditsGet AI agent credit balance
الصلاحية المطلوبة
agent:read
الردود
- 200Balances in cents: the remaining free allowance, the wallet, their sum, and whether pay-as-you-go billing has been enabled.
  { "ai_trial_cents": 500, "wallet_cents": 1240, "total_cents": 1740, "billing_enabled": false }
مثال
```
curl https://api.evorxa.com/api/agent/credits \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/agent/billing/enableEnable pay-as-you-go AI billing
Explicit opt-in to wallet charging. Until this is called the agent only spends the free allowance and stops with a 402 (error `ai_billing_required`) when it runs out; afterwards, usage past the allowance debits the wallet. One-way: there is no disable endpoint. Idempotent.
الصلاحية المطلوبة
agent:write
الردود
- 200The updated balance breakdown.
  { "ai_trial_cents": 0, "wallet_cents": 1240, "total_cents": 1240, "billing_enabled": true }
مثال
```
curl -X POST https://api.evorxa.com/api/agent/billing/enable \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/agent/chatSend a message to the agent
Starts a new conversation or appends to an existing one. The agent may issue tool calls (shell, file edit) which run on your instance via SSH. Each tool call and token is metered.
الصلاحية المطلوبة
agent:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
جسم الطلب
الاسم النوع الوصف
messageإلزامي string User prompt.
conversation_id integer Optional. Continue an existing conversation.
الردود
- 200Conversation record with appended assistant message + any tool transcripts.
- 402No spendable AI credit. `error` is `ai_billing_required` when the free allowance is gone and billing was never enabled (fix: POST /agent/billing/enable), or `insufficient_ai_credits` when billing is enabled but the wallet is empty (fix: top up).
- 403Instance is suspended.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/agent/chat \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message":"","conversation_id":0}'
```
GET/instances/{id}/agent/conversationsList conversations for an instance
الصلاحية المطلوبة
agent:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Conversations, newest first. Each carries `cost_cents`, the total that chat has consumed.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/agent/conversations \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/{id}/agent/conversations/{convId}Get a conversation transcript
الصلاحية المطلوبة
agent:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
convIdإلزامي integer Conversation ID.
الردود
- 200Full message + tool call transcript, with the conversation's accumulated `cost_cents`.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/agent/conversations/{convId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
DELETE/instances/{id}/agent/conversations/{convId}Delete a conversation
الصلاحية المطلوبة
agent:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
convIdإلزامي integer Conversation ID.
الردود
- 204Deleted.
مثال
```
curl -X DELETE https://api.evorxa.com/api/instances/{id}/agent/conversations/{convId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/instances/{id}/agent/telegramGet Telegram link status
الصلاحية المطلوبة
agent:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
الردود
- 200Linked Telegram chat ID, or null.
مثال
```
curl https://api.evorxa.com/api/instances/{id}/agent/telegram \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/instances/{id}/agent/telegramLink a Telegram chat to the agent
الصلاحية المطلوبة
agent:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي string Instance UUID.
جسم الطلب
الاسم النوع الوصف
telegram_chat_idإلزامي string From the /start reply.
الردود
- 200Linked.
مثال
```
curl -X POST https://api.evorxa.com/api/instances/{id}/agent/telegram \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"telegram_chat_id":""}'
```

الاسم	النوع	الوصف
`message`إلزامي	`string`	User prompt.
`conversation_id`	`integer`	Optional. Continue an existing conversation.

الاسم	النوع	الوصف
`telegram_chat_id`إلزامي	`string`	From the /start reply.

shield

Shield · Firewall & Visibility

Per-IP firewall rules, RDNS, bandwidth caps, and ingress visibility (top IPs, top ASNs, country breakdown, port mix, PPS). Backed by in-house Shield nodes.

GET/shield/ipsList protected IPs
الصلاحية المطلوبة
shield:read
الردود
- 200IPs with rule counts, policy summary, current bandwidth.
مثال
```
curl https://api.evorxa.com/api/shield/ips \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}Get a protected IP
الصلاحية المطلوبة
shield:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Full IP profile: rules, policy, RDNS.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

POST/shield/ips/{id}/rulesCreate a firewall rule

الصلاحية المطلوبة

shield:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`integer`	IP record ID.

جسم الطلب

الاسم	النوع	الوصف
`action`إلزامي	`string`	"allow" or "block".
`protocol`إلزامي	`string`	"tcp", "udp", or "any".
`src_cidr`	`string`	Source CIDR. Defaults to 0.0.0.0/0.
`dst_port`	`integer`	Destination port. Null = any.

الردود

201Rule created and pushed to Shield nodes.

مثال

curl -X POST https://api.evorxa.com/api/shield/ips/{id}/rules \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"","protocol":"","src_cidr":"","dst_port":0}'

PUT/shield/ips/{id}/rules/{ruleId}Update a firewall rule
الصلاحية المطلوبة
shield:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
ruleIdإلزامي integer Rule ID.
الردود
- 200Updated.
مثال
```
curl -X PUT https://api.evorxa.com/api/shield/ips/{id}/rules/{ruleId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
DELETE/shield/ips/{id}/rules/{ruleId}Delete a firewall rule
الصلاحية المطلوبة
shield:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
ruleIdإلزامي integer Rule ID.
الردود
- 204Deleted.
مثال
```
curl -X DELETE https://api.evorxa.com/api/shield/ips/{id}/rules/{ruleId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
PUT/shield/ips/{id}/policyUpdate default policy
الصلاحية المطلوبة
shield:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
جسم الطلب
الاسم النوع الوصف
default_in string "allow" or "block".
default_out string "allow" or "block".
الردود
- 200Policy updated.
مثال
```
curl -X PUT https://api.evorxa.com/api/shield/ips/{id}/policy \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"default_in":"","default_out":""}'
```
GET/shield/ips/{id}/bandwidthBandwidth samples
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Time-series of bps in/out.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/bandwidth \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}/visibility/top-ipsTop source IPs
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Ranked list of source IPs by bytes/packets.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/visibility/top-ips \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}/visibility/top-asnsTop source ASNs
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Ranked ASN list.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/visibility/top-asns \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}/visibility/countriesCountry breakdown
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Country share of incoming traffic.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/visibility/countries \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}/visibility/portsPort distribution
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Most-hit destination ports.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/visibility/ports \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/ips/{id}/visibility/ppsPackets per second
الصلاحية المطلوبة
analytics:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer IP record ID.
الردود
- 200Time-series PPS.
مثال
```
curl https://api.evorxa.com/api/shield/ips/{id}/visibility/pps \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

waf

Web Application Firewall

Front an instance with a managed WAF + DDoS layer on the network edge. Each application gets its own protected hostname with an automatically issued certificate; point your own domains at it, tune enforcement, and read traffic, threat and live-event analytics.

GET/shield/wafList WAF applications
الصلاحية المطلوبة
waf:read
الردود
- 200Applications with their hostnames, enforcement state and origin.
مثال
```
curl https://api.evorxa.com/api/shield/waf \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

POST/shield/wafCreate a WAF application

الصلاحية المطلوبة

waf:write

جسم الطلب

الاسم	النوع	الوصف
`instance_id`إلزامي	`string`	The instance to protect (its IP becomes the origin).
`name`إلزامي	`string`	Application label (max 100 chars).
`template`إلزامي	`string`	http, https, or custom.
`port`	`integer`	Origin port, required when template is custom (1–65535).

الردود

201Application created with its protected hostname; the certificate is issued automatically.
422The instance is not provisioned yet, or it already has the maximum of 2 applications. Delete one to free a slot.

مثال

curl -X POST https://api.evorxa.com/api/shield/waf \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"instance_id":"","name":"","template":"","port":0}'

GET/shield/waf/{id}Get a WAF application
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
الردود
- 200Application with its hostnames and certificate status.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
DELETE/shield/waf/{id}Delete a WAF application
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
الردود
- 200Deleted, along with its hostnames and certificates.
مثال
```
curl -X DELETE https://api.evorxa.com/api/shield/waf/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/shield/waf/{id}/firewallToggle WAF enforcement
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
جسم الطلب
الاسم النوع الوصف
enabledإلزامي boolean true blocks malicious requests; false runs detect-only.
الردود
- 200Enforcement updated.
مثال
```
curl -X POST https://api.evorxa.com/api/shield/waf/{id}/firewall \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'
```
POST/shield/waf/{id}/under-attackToggle under-attack mode
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
جسم الطلب
الاسم النوع الوصف
enabledإلزامي boolean Serve from a short-TTL edge cache during a surge so floods never reach the origin.
الردود
- 200Mode updated.
مثال
```
curl -X POST https://api.evorxa.com/api/shield/waf/{id}/under-attack \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'
```

PUT/shield/waf/{id}/settingsUpdate protection settings

الصلاحية المطلوبة

waf:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`integer`	Application ID.

جسم الطلب

الاسم	النوع	الوصف
`waf_mode`	`string`	block, detect, or off.
`challenge_enabled`	`boolean`	Show a proof-of-work challenge under attack.
`cache_enabled`	`boolean`	Cache eligible responses at the edge.
`attack_cache`	`boolean`	Under-attack micro-cache.
`rate_avg`	`integer`	Sustained requests/sec per client.
`rate_burst`	`integer`	Burst allowance.

الردود

200Settings updated (they apply to every hostname of the application).

مثال

curl -X PUT https://api.evorxa.com/api/shield/waf/{id}/settings \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"waf_mode":"","challenge_enabled":false,"cache_enabled":false,"attack_cache":false,"rate_avg":0,"rate_burst":0}'

GET/shield/waf/{id}/analyticsTraffic & threat analytics
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
بارامترات الـQuery
الاسم النوع الوصف
period string 24h (default), 7d, or 30d.
الردود
- 200Totals, a time series, top paths/IPs/countries/ASNs, an activity heatmap and threat figures.
- 502Analytics temporarily unavailable.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id}/analytics \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/waf/{id}/eventsLive security events
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
بارامترات الـQuery
الاسم النوع الوصف
limit integer Max events (1–200, default 100).
الردود
- 200Recent blocked/challenged/inspected requests, newest first.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id}/events \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/shield/waf/{id}/hostnamesAdd a hostname (verify DNS)
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
جسم الطلب
الاسم النوع الوصف
hostnameإلزامي string Domain to protect (max 255 chars).
الردود
- 200DNS is not pointing at us yet. Returns { verified: false, dns } with the CNAME record to create, and nothing is added. Create the record (DNS-only, no proxy) and call again.
- 201DNS verified; the hostname is added and its certificate is issued automatically. Returns { verified: true, hostname, dns }.
مثال
```
curl -X POST https://api.evorxa.com/api/shield/waf/{id}/hostnames \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"hostname":""}'
```
POST/shield/waf/{id}/hostnames/{hostnameId}/retry-sslRe-check DNS & issue certificate
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
hostnameIdإلزامي integer Hostname ID.
الردود
- 200Hostname re-checked; certificate issued when DNS is in place.
مثال
```
curl -X POST https://api.evorxa.com/api/shield/waf/{id}/hostnames/{hostnameId}/retry-ssl \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
DELETE/shield/waf/{id}/hostnames/{hostnameId}Remove a hostname
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
hostnameIdإلزامي integer Hostname ID.
الردود
- 204Removed.
مثال
```
curl -X DELETE https://api.evorxa.com/api/shield/waf/{id}/hostnames/{hostnameId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/waf/{id}/liveLive view (events, counters, map)
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
بارامترات الـQuery
الاسم النوع الوصف
since_id integer Return events after this id (cursor).
الردود
- 200Cursor events plus the current 5-minute window: live counters, per-country traffic (for the map), and top paths.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id}/live \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/waf/{id}/rulesList custom rules
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
الردود
- 200Your allow/block/challenge/log rules, in priority order.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id}/rules \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

POST/shield/waf/{id}/rulesCreate a custom rule

الصلاحية المطلوبة

waf:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`integer`	Application ID.

جسم الطلب

الاسم	النوع	الوصف
`name`إلزامي	`string`	Label (max 120 chars).
`action`إلزامي	`string`	block \| challenge \| allow \| log.
`priority`	`integer`	0–100000, lower runs first (default 100).
`enabled`	`boolean`	Default true.
`match`إلزامي	`object`	Conditions (all must match): path {op: prefix\|exact\|regex, value}, method [..], ip {op: in\|not_in, cidrs: [..]}, header {name, op: exists\|missing\|equals, value?}, query {name, op, value?}.

الردود

201Rule created.

مثال

curl -X POST https://api.evorxa.com/api/shield/waf/{id}/rules \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"","action":"","priority":0,"enabled":false,"match":null}'

PUT/shield/waf/{id}/rules/{ruleId}Update a custom rule
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
ruleIdإلزامي integer Rule ID.
جسم الطلب
الاسم النوع الوصف
(any create field) object Send only the fields to change.
الردود
- 200Rule updated.
مثال
```
curl -X PUT https://api.evorxa.com/api/shield/waf/{id}/rules/{ruleId} \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"(any create field)":null}'
```
DELETE/shield/waf/{id}/rules/{ruleId}Delete a custom rule
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
ruleIdإلزامي integer Rule ID.
الردود
- 200Removed.
مثال
```
curl -X DELETE https://api.evorxa.com/api/shield/waf/{id}/rules/{ruleId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/shield/waf/{id}/exclusionsList WAF exclusions
الصلاحية المطلوبة
waf:read
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
الردود
- 200Rules you've excused for your own legitimate traffic.
مثال
```
curl https://api.evorxa.com/api/shield/waf/{id}/exclusions \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

POST/shield/waf/{id}/exclusionsCreate a WAF exclusion

الصلاحية المطلوبة

waf:write

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`integer`	Application ID.

جسم الطلب

الاسم	النوع	الوصف
`rule_id`إلزامي	`string`	The rule number to relax (digits only).
`path_prefix`	`string`	Optional. Limit to paths starting with this.
`target`	`string`	Optional. A single input to ignore (e.g. REQUEST_COOKIES); empty disables the whole rule.
`note`	`string`	Optional note (max 300 chars).
`enabled`	`boolean`	Default true.

الردود

201Exclusion created.

مثال

curl -X POST https://api.evorxa.com/api/shield/waf/{id}/exclusions \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rule_id":"","path_prefix":"","target":"","note":"","enabled":false}'

PUT/shield/waf/{id}/exclusions/{xid}Update a WAF exclusion
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
xidإلزامي integer Exclusion ID.
جسم الطلب
الاسم النوع الوصف
(any create field) object Send only the fields to change.
الردود
- 200Exclusion updated.
مثال
```
curl -X PUT https://api.evorxa.com/api/shield/waf/{id}/exclusions/{xid} \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"(any create field)":null}'
```
DELETE/shield/waf/{id}/exclusions/{xid}Delete a WAF exclusion
الصلاحية المطلوبة
waf:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Application ID.
xidإلزامي integer Exclusion ID.
الردود
- 200Removed.
مثال
```
curl -X DELETE https://api.evorxa.com/api/shield/waf/{id}/exclusions/{xid} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

wallet

Wallet & Billing

Balance, transactions, and invoices. Wallet is the money primitive: all paid actions (instance create/upgrade, reactivate) debit from it. Every server issues a renewal invoice 5 days before its due date; invoices are settled from wallet credit or paid directly by card or local payment.

GET/wallet/balanceGet wallet balance

الصلاحية المطلوبة

wallet:read

الردود

200Balance and a fresh exchange rate.

{ "balance_cents": 5240, "balance_usd": 52.40 }

مثال

curl https://api.evorxa.com/api/wallet/balance \
  -H "Authorization: Bearer $EVORXA_TOKEN"

GET/wallet/transactionsList transactions
The wallet ledger, newest first. Every paid action appears here with the balance it left behind.
الصلاحية المطلوبة
wallet:read
بارامترات الـQuery
الاسم النوع الوصف
page integer Page number. Default 1.
per_page integer Rows per page. Default 20, maximum 100.
الردود
- 200Paginated transaction ledger.
مثال
```
curl https://api.evorxa.com/api/wallet/transactions \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/invoicesList invoices
Paginated invoice history, newest first. Renewal invoices are issued 5 days before an instance's due date and settle automatically from wallet credit when the balance covers them; wallet top-ups appear as already-paid invoices. Unpaid invoices past their due date carry is_overdue: true.
الصلاحية المطلوبة
wallet:read
بارامترات الـQuery
الاسم النوع الوصف
status string Optional filter: "unpaid", "paid", or "cancelled".
page integer Page number, 20 invoices per page.
الردود
- 200Paginated invoices
  { "data": [ { "id": 118, "number": "INV-000118", "type": "renewal", "status": "unpaid", "amount_cents": 699, "amount_formatted": "$6.99", "is_overdue": false, "due_date": "2026-08-16", "paid_at": null, "payment_method": null, "instance": { "id": "e2a6…", "name": "web-1" } } ], "current_page": 1, "last_page": 1, "total": 1 }
مثال
```
curl https://api.evorxa.com/api/invoices \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

GET/invoices/{id}Get an invoice

A single invoice with its line items and billing period.

الصلاحية المطلوبة

wallet:read

بارامترات المسار

الاسم	النوع	الوصف
`id`إلزامي	`integer`	Invoice id.

الردود

200Invoice with line items

{
  "id": 118,
  "number": "INV-000118",
  "type": "renewal",
  "status": "unpaid",
  "amount_cents": 699,
  "due_date": "2026-08-16",
  "period_start": "2026-08-16T00:00:00Z",
  "period_end": "2026-09-16T00:00:00Z",
  "items": [
    { "description": "Renewal: web-1 std.1 (monthly)", "item_type": "plan", "amount_cents": 599 },
    { "description": "Extra IP (monthly)", "item_type": "addon", "amount_cents": 100 }
  ]
}

404Invoice not found or not yours.

مثال

curl https://api.evorxa.com/api/invoices/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"

announcements

Announcements

Platform notices: new regions, planned maintenance, product changes. Read-only, and safe to poll on a schedule.

GET/announcementsList active announcements

Returns up to 10 currently active announcements ordered by sort order, then newest first. Arabic fields are null when no translation was provided; body is null when there is no long-form text.

الردود

200Active announcements

[
  {
    "id": 3,
    "title": "New region online",
    "title_ar": "منطقة جديدة متاحة",
    "excerpt": "Deploy servers in our newest location starting today.",
    "excerpt_ar": "انشر خوادمك في أحدث مواقعنا ابتداءً من اليوم.",
    "body": "Full details about the new region...",
    "body_ar": null,
    "image_url": "https://cdn.example.com/announcements/region.png",
    "created_at": "2026-07-20T10:00:00Z"
  }
]

مثال

curl https://api.evorxa.com/api/announcements \
  -H "Authorization: Bearer $EVORXA_TOKEN"

catalog

Catalog

What you can buy. Public read-only catalog (no auth) plus an authenticated /me view.

GET/catalog/plansPublic plans (no auth)
بارامترات الـQuery
الاسم النوع الوصف
currency string Optional. USD (default), SAR, or EGP. Converts prices using the latest stored rate.
الردود
- 200Plan categories with per-cycle pricing in the requested currency.
مثال
```
curl https://api.evorxa.com/api/catalog/plans \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/catalog/regionsPublic regions (no auth)
الردود
- 200Region codes, names, flags.
مثال
```
curl https://api.evorxa.com/api/catalog/regions \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/catalog/billing-cyclesPublic billing cycles (no auth)
الردود
- 200Monthly, 6-month, yearly + their cycle discounts.
مثال
```
curl https://api.evorxa.com/api/catalog/billing-cycles \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/catalog/exchange-ratesPublic USD-based FX rates (no auth)
الردود
- 200Rates for USD, SAR, EGP plus the fetched_at timestamp. Refreshed daily from public reference data.
مثال
```
curl https://api.evorxa.com/api/catalog/exchange-rates \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/me/catalog/plansAuthenticated plans
الردود
- 200Same shape as public, with personalised pricing applied.
مثال
```
curl https://api.evorxa.com/api/me/catalog/plans \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
GET/catalog/os-templates/{packageId}OS templates for a package
الصلاحية المطلوبة
instances:read
بارامترات المسار
الاسم النوع الوصف
packageIdإلزامي integer Plan package ID.
الردود
- 200OS groups with template variants.
مثال
```
curl https://api.evorxa.com/api/catalog/os-templates/{packageId} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

GET/catalog/appsPublic one-click applications (no auth)

Applications that can be installed on a new server at creation time. Pass a slug as app_slug to POST /instances, and read the resulting sign-in details from GET /instances/{id}/app. Check min_ram_mb and min_storage_gb against the plan you intend to buy, since an application larger than its plan is refused.

الردود

200Available applications.

{
  "apps": [
    {
      "slug": "wordpress",
      "name": "WordPress",
      "tagline": "The website and blogging platform behind most of the web",
      "category": "cms",
      "default_username": "admin",
      "generates_password": true,
      "setup_note": null,
      "license_required_upfront": false,
      "min_ram_mb": 2048,
      "min_storage_gb": 20
    }
  ]
}

مثال

curl https://api.evorxa.com/api/catalog/apps \
  -H "Authorization: Bearer $EVORXA_TOKEN"

ssh-keys

SSH Keys

Public SSH keys that can be injected at instance build time. Stored once, reused everywhere.

GET/ssh-keysList SSH keys
الصلاحية المطلوبة
instances:read
الردود
- 200Your registered keys.
مثال
```
curl https://api.evorxa.com/api/ssh-keys \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```
POST/ssh-keysAdd an SSH key
الصلاحية المطلوبة
instances:write
جسم الطلب
الاسم النوع الوصف
nameإلزامي string Label.
public_keyإلزامي string OpenSSH-format public key.
الردود
- 201Created.
مثال
```
curl -X POST https://api.evorxa.com/api/ssh-keys \
  -H "Authorization: Bearer $EVORXA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"","public_key":""}'
```
DELETE/ssh-keys/{id}Delete an SSH key
الصلاحية المطلوبة
instances:write
بارامترات المسار
الاسم النوع الوصف
idإلزامي integer Key ID.
الردود
- 204Deleted.
مثال
```
curl -X DELETE https://api.evorxa.com/api/ssh-keys/{id} \
  -H "Authorization: Bearer $EVORXA_TOKEN"
```

الاسم	النوع	الوصف
`default_in`	`string`	"allow" or "block".
`default_out`	`string`	"allow" or "block".

الاسم	النوع	الوصف
`page`	`integer`	Page number. Default 1.
`per_page`	`integer`	Rows per page. Default 20, maximum 100.

الاسم	النوع	الوصف
`status`	`string`	Optional filter: "unpaid", "paid", or "cancelled".
`page`	`integer`	Page number, 20 invoices per page.

الاسم	النوع	الوصف
`name`إلزامي	`string`	Label.
`public_key`إلزامي	`string`	OpenSSH-format public key.