Packages

Rotate proxy package password

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.

post/v1/proxy/packages/{package_id}/rotate-password

Request

Base URL
https://api.platform.soax.com
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.

Path parameters

package_idstring required

The package ID

Response

Successful Response

passwordstring required

The newly generated plaintext password/key

Example response

{
  "password": "a1b2c3d4e5"
}

Changes

No recorded changes to this operation across all 1 revision of this API.