neosourceDocs
Search docs

Delete an SSH key

DELETE/api/user/ssh-keys/{key_id}

deleteSshKey

Session-authenticated caller only. Removes an SSH public key belonging to the authenticated user.

Requires authentication using a session cookie — see tokens and scopes.

curl

curl -X DELETE 'https://neosource.dev/api/user/ssh-keys/KEY_ID' \
  -b 'ns_session=$NEOSOURCE_SESSION'

fetch

fetch("https://neosource.dev/api/user/ssh-keys/KEY_ID", {
  method: "DELETE",
  credentials: "include",
});

Path parameters

key_idrequired

SSH key ID to delete.

string

Responses

204Key deleted

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden

  • NeedsScopeError

    object

    `403` body returned when listing private repos but the linked identity lacks the required provider scope. The SPA turns this into an incremental-authorization prompt (Tier 2) that calls the `/elevate` OAuth endpoint with this `scope`.

    errorrequired

    string

    Always `needs_scope` — this body exists to carry the extra fields that kind needs.

    "needs_scope"

    scoperequired

    string

    The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 404Not Found — one of: not_found
  • 409Conflict — one of: already_exists, conflict
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget