---
title: "Rotate proxy package password"
method: POST
path: "/v1/proxy/packages/{package_id}/rotate-password"
tags: ["Packages"]
---

# Rotate proxy package password

`POST /v1/proxy/packages/{package_id}/rotate-password`

## Request

- Base URL: `https://api.platform.soax.com`
- URL: `https://api.platform.soax.com/v1/proxy/packages/{package_id}/rotate-password`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/soax/apis/soax-api/docs/v1/proxy/packages/:package_id/rotate-password/post.ts> (a function with typed inputs; its response is checked against the schema)

Generate a new package password (the 10-character key used to authenticate proxy requests — not the API key). The old password stops working immediately, so update every client that connects through this package. The new plaintext password is returned only in this response.

Returns 400 if the package is deleted or suspended.

Requires the `proxy:packages:write` scope.

## Path parameters

- `package_id` string, required: The package ID

## Response `200`

Successful Response

- PackagePasswordResponse: Response schema for password rotation endpoint.
  - `password` string, required: The newly generated plaintext password/key

## Other responses

- `400`: A parameter value is invalid. Depending on which validation layer rejects the request, the message is under `detail` (endpoint-level checks) or `error` (service-level checks); read `detail ?? error`. The message names the parameter and lists valid values where applicable.
- `401`: Missing, invalid, or revoked API key.
- `403`: The API key does not carry the scope this endpoint requires.
- `404`: The resource does not exist, belongs to another organization, or is outside the API key's package restriction.
- `422`: Validation Error
- `429`: Rate limit exceeded (5 requests/second per API key, 500 requests/minute per IP). The response includes `Retry-After` (seconds), `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix time) headers — wait `Retry-After` seconds and retry.

---

[API](https://skmtc.dev/soax/apis/soax-api.md) - [All operations](https://skmtc.dev/soax/apis/soax-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soax/apis/soax-api/revisions/2abdaa934277?raw)