REST API

This page documents the intended V2 REST contract from protocol/SPECIFICATION.md.

Some deployed gateway routes are still catching up, but the spec is authoritative.

Address-native selectors

V2 REST surfaces are keyed by owner_address.

Examples of normative request/response changes:

• project owner filters use owner_address
• account lookups use owner_address
• link reverse lookups use target_owner_address
• commit and ref history entries expose owner_address or author_address

Disabled relay-era surfaces

V2 REST documentation must not model these as active message families:

• KEY_ADD
• OWNERSHIP_TRANSFER
• STORAGE_RENT
• RELAY_SIGNER_ADD
• RELAY_SIGNER_REMOVE

Write endpoints

The write path still revolves around signed Message submission:

• submit one message
• dry-run one message
• batch submit multiple messages

Read model highlights

• projects expose owner_address
• account summaries are address-native
• collaborator entries are address-native
• commit metadata uses author_address
• ref log entries use owner_address
• merge request summaries include requester_owner_address, source_project_id, source_ref, and target_ref

Merge request endpoints

• GET /v1/projects/{projectId}/merge-requests — list active merge requests targeting a project
• GET /v1/projects/{projectId}/merge-requests/{requestId} — get a specific merge request
• GET /v1/accounts/{ownerAddress}/merge-requests — list active merge requests opened by an account

On the REST surface, source_ref and target_ref are exposed as hex-encoded bytes so non-UTF-8 ref names round-trip without loss.

See RPC reference for field details.