Skip to content

docs(api): publish canonical endpoint matrix, remove dead API hosts #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
moshemalawach wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(api): publish canonical endpoint matrix, remove dead API hosts #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions docs/devhub/api/rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,32 @@ Aleph Cloud provides a comprehensive REST API that allows developers to interact
All API endpoints are available at:

```
https://api.aleph.cloud/api/v0/
https://api.aleph.im/api/v0/
```

For development and testing, you can also use:
As an alternative, you can also use:

```
https://api1.aleph.cloud/api/v0/
https://official.aleph.cloud/api/v0/
```

## Endpoint Matrix

The canonical list of public Aleph Cloud service endpoints:

| Service | URL | Notes |
| ---------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------- |
| Core Channel Node API (read/write) | `https://api.aleph.im` | Load-balanced. Primary endpoint for messages, aggregates, storage, balances. |
| Core Channel Node API (alt) | `https://official.aleph.cloud` | Same API; also serves node metrics. |
| Additional CCN mirrors | `https://api2.aleph.im`, `https://api3.aleph.im` | Use for redundancy or load distribution. |
| VM Scheduler | `https://scheduler.api.aleph.cloud` | `/api/v0/plan`, `/api/v0/allocation/{vm_hash}`, `/api/v0/nodes`. |
| Network status | `https://status.aleph.im` | `/api/services` for machine-readable health. |
| Credit API | `https://credit.aleph.im/api/v0` | `/payment` (paginated purchases), `/estimation/token-to-credit`. |

To quickly verify that the API is reachable:

```bash
curl https://api.aleph.im/api/v0/info/public.json
```

## Authentication
Expand Down Expand Up @@ -422,8 +441,8 @@ POST /run/{program_hash}

#### Parameters

| Parameter | Type | Description |
| ------------- | ------ | ---------------------------------- |
| Parameter | Type | Description |
| -------------- | ------ | ---------------------------------- |
| `program_hash` | string | The hash of the program to execute |

#### Request Body
Expand Down Expand Up @@ -507,8 +526,8 @@ GET /instances/{instance_id}

#### Parameters

| Parameter | Type | Description |
| ------------ | ------ | ---------------------------------- |
| Parameter | Type | Description |
| ------------- | ------ | ---------------------------------- |
| `instance_id` | string | The ID of the instance to retrieve |

#### Response
Expand Down
8 changes: 4 additions & 4 deletions docs/devhub/sdks-and-tools/aleph-cli/commands/message.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,12 @@ aleph message sync [OPTIONS] --source <SOURCE> --target <TARGET>
```bash
# Sync messages between two nodes
aleph message sync \
--source https://api1.aleph.cloud \
--target https://api2.aleph.cloud
--source https://api.aleph.im \
--target https://api2.aleph.im

# Dry-run to preview what would be synced
aleph message sync \
--source https://api1.aleph.cloud \
--target https://api2.aleph.cloud \
--source https://api.aleph.im \
--target https://api2.aleph.im \
--dry-run
```
4 changes: 2 additions & 2 deletions docs/devhub/sdks-and-tools/python-sdk/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The `AuthenticatedAlephHttpClient` requires an `Account` object for signing mess
```python
async with AuthenticatedAlephHttpClient(
account=account,
api_server="https://api1.aleph.im", # Optional
api_server="https://api.aleph.im", # Optional
api_unix_socket=None, # Optional
allow_unix_sockets=True, # Optional
timeout=None, # Optional
Expand Down Expand Up @@ -293,7 +293,7 @@ The `AlephHttpClient` class serves as the fundamental client for interacting wit

```python
async with AlephHttpClient(
api_server="https://api1.aleph.im", # Optional
api_server="https://api.aleph.im", # Optional
api_unix_socket=None, # Optional
allow_unix_sockets=True, # Optional
timeout=None, # Optional
Expand Down
2 changes: 1 addition & 1 deletion docs/nodes/resources/management/monitoring/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The main endpoints to monitor are:

Examples:

- Aleph CCN: [https://official.aleph.cloud/metrics](https://api.aleph.im/metrics)
- Aleph CCN: [https://official.aleph.cloud/metrics](https://official.aleph.cloud/metrics)
- Aleph Staging CRN: [https://ovh.staging.aleph.sh/status/check/fastapi](https://ovh.staging.aleph.sh/status/check/fastapi)

## Resource monitoring
Expand Down