DevOps & Config
SSH Key Pair Checker & Matcher API
GET request to /v1/ssh-key-checker, returning json in the standard envelope.
GET
/v1/ssh-key-checker2 credits / call Free tierAuthentication
Send your API key as a bearer token. Create one free in the dashboard.
Authorization: Bearer $TOOLSXPO_KEYParameters
Sent as query-string parameters. The values below are the examples used throughout this page.
| Name | Example value |
|---|---|
| privateKey | |
| publicKey | ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIH2sM8kL9pQrT1vXyZ0aB3cD4eF5gH6iJ7kL8mN9oP0q user@example.com |
| autoFix | true |
Example request
curl "https://api.toolsxpo.com/v1/ssh-key-checker?privateKey=&publicKey=ssh-ed25519%20AAAAC3NzaC1lZDI1NTE5AAAAIH2sM8kL9pQrT1vXyZ0aB3cD4eF5gH6iJ7kL8mN9oP0q%20user%40example.com&autoFix=true" \
-H "Authorization: Bearer $TOOLSXPO_KEY"Response
Every endpoint answers with the same envelope. The result is in data (json); meta.credits reports what the call cost.
{
"ok": true,
"data": { /* json */ },
"meta": { "credits": 2 }
}Errors
Failures use the same envelope with ok: false and a machine-readable code.
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_input | A parameter failed validation. `details` lists which. |
| 401 | unauthorized | Missing or invalid API key. |
| 402 | quota_exceeded | Out of credits on this workspace. |
| 404 | not_found | No such tool. |
| 429 | rate_limited | Too many requests. Retry after `Retry-After` seconds. |
| 503 | service_unavailable | Temporarily disabled by an administrator. |