Stellar · Schema
UpdateAPIKeyRequest
BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3
Properties
| Name | Type | Description |
|---|---|---|
| permissions | array | List of permissions granted to this API key |
| allowed_ips | object | IP restrictions for the API key. If not provided, existing restrictions remain unchanged |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://developers.stellar.org/schemas/sdp/UpdateAPIKeyRequest.json",
"title": "UpdateAPIKeyRequest",
"type": "object",
"required": [
"permissions"
],
"properties": {
"permissions": {
"type": "array",
"description": "List of permissions granted to this API key",
"items": {
"type": "string",
"enum": [
"read:all",
"write:all",
"read:disbursements",
"write:disbursements",
"read:receivers",
"write:receivers",
"read:payments",
"write:payments",
"read:organization",
"write:organization",
"read:users",
"write:users",
"read:wallets",
"write:wallets",
"read:statistics",
"read:exports"
]
},
"minItems": 1
},
"allowed_ips": {
"oneOf": [
{
"type": "string",
"description": "Single IP address or CIDR range"
},
{
"type": "array",
"items": {
"type": "string"
},
"description": "Array of IP addresses or CIDR ranges"
}
],
"description": "IP restrictions for the API key. If not provided, existing restrictions remain unchanged"
}
}
}