API product catalogDeveloper Platform, Sandbox & Key Management

Rotate API key

Developer Platform, Sandbox & Key Management

POST

/api-keys/rotate

Rotate API key

Sandbox availablecreateRotate

Issues a new primary API key and immediately suspends the current credential. Partner data remains attached to the same stable partner identity. The new key is returned once in newApiKey; store it securely before closing the response. There is no overlap window.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

confirmtrueRequired

Explicit acknowledgement that the current key will stop working immediately.

Response fields

messagestring

newApiKeystring

New primary API key. Store immediately — shown once.

oldApiKeystring

Masked form of the credential that was suspended.

notestring

Response codes

200Key rotated.

Request reference

Sandbox available

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/sandbox/v1/partner/api-keys/rotate

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "newApiKey": {
      "type": "string",
      "description": "New primary API key. Store immediately — shown once."
    },
    "oldApiKey": {
      "type": "string",
      "description": "Masked form of the credential that was suspended."
    },
    "note": {
      "type": "string"
    }
  }
}

curl -X POST 'https://mystocks.africa/api/sandbox/v1/partner/api-keys/rotate' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "confirm": true
}'

POST /api-keys/revoke

POST /apply