Delete a Portfolio API key using a JSON body. Main User Level key with TRADE required.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Deletes an API key associated with a RapidX Portfolio under the main user. It does not delete the Portfolio or change its assets. Treat deletion as permanent; create a new key if access is needed again.
API key access
Requires a signed LTP Open API request with TRADE permission on the calling key.
| API key type | Can call | Scope |
|---|---|---|
| Main User Level API key (also the Main Portfolio key) | Yes | API keys for RapidX Portfolios under the main user. |
| Sub-user Level API key | No | This Open API endpoint does not support Sub-user Level keys. |
| Sub Portfolio Level API key | No | TRADE on a Sub Portfolio key does not grant API key management access. |
Client UI access and Open API access are different. A sub-user's ability to manage an assigned Portfolio's keys in the client does not allow their Sub-user Level key to call this endpoint. See API Management.
Sub-user Level keys do not support TRADE and cannot use this endpoint.
Rate limit
3 requests per 10 seconds.
Request body
Send parameters as a JSON body with Content-Type: application/json.
| Name | Type | Required | Description |
|---|---|---|---|
portfolioId | integer (int64) | Yes | RapidX Portfolio ID under the main user. This is not a user UID or a DMA account ID. |
portfolioApiKey | string | Yes | The target key's accessKey, returned by creation or listing. This is not the caller key used to sign the request. |
Response fields
| Field | Type | Description |
|---|---|---|
code | integer | Application result code. 200 means success. |
message | string | Result message. |
data | object | The deleted key identifier. |
Key result: data
data| Field | Type | Description |
|---|---|---|
data.portfolioId | integer (int64) | Portfolio identifier. Preserve the full integer value. |
data.apiName | string | Key label. |
data.accessKey | string | Identifier of the deleted key. |
data.updatedAt | integer (int64) | Deletion time, Unix timestamp in milliseconds. |
Example request
{
"portfolioId": 2154503491108165,
"portfolioApiKey": "EXAMPLE_ACCESS_KEY"
}The 200 response example shows the successful response structure. Credentials in examples are placeholders.
Error responses
Check the application code even when the HTTP status is 200.
| Code | Meaning / action |
|---|---|
2003 | Permission denied. The calling key type is not supported by this endpoint. |
2004 | The calling key lacks TRADE. Sub-user Level keys cannot be granted this permission and are not supported. |
See Error codes for common authentication and request errors.