> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SIP Credentials API

> Issue SIP REGISTER credentials for softphones (Linphone, Zoiper, Bria) and desk phones to connect to the Orbit voice plane.

# SIP Credentials API

Issue SIP credentials so a third-party softphone or hardware desk phone can register with Orbit's voice plane and receive / place calls on tenant numbers. Credentials authenticate against the Kamailio + Jambonz edge.

**Base path:** `/api/v1/sip-credentials`

**Authentication:** API key (`X-API-Key`) or session JWT.

| Method   | Path                                      | Purpose                       |
| -------- | ----------------------------------------- | ----------------------------- |
| `GET`    | `/api/v1/sip-credentials/`                | List credentials              |
| `POST`   | `/api/v1/sip-credentials/`                | Issue a new credential        |
| `GET`    | `/api/v1/sip-credentials/{id}`            | Get a credential              |
| `PATCH`  | `/api/v1/sip-credentials/{id}`            | Update label / restrictions   |
| `DELETE` | `/api/v1/sip-credentials/{id}`            | Revoke                        |
| `POST`   | `/api/v1/sip-credentials/{id}/rotate`     | Rotate password               |
| `POST`   | `/api/v1/sip-credentials/{id}/unregister` | Force-unregister all sessions |

## Example — issue a credential for a desk phone

```bash theme={null}
curl -X POST https://api.orbit.devotel.io/api/v1/sip-credentials/ \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Reception desk - Yealink T46U",
    "extensionNumber": "100",
    "outboundEnabled": true
  }'
```

The response includes `username`, `password` (shown once), `sip_server`, `sip_realm`, `sip_port_tls` (5061), and `sip_port_tcp` (5060) — configure these on the device. The `password` is returned once, on creation; use `rotate` if a password is lost.

## See also

* [Voice API](/api-reference/voice) — programmatic call control once registered
* [Browser Softphone](/api-reference/sdk) — for in-browser softphones via the web SDK