Stellar · Schema

CreateAPIKeyRequest

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3

Properties

Name Type Description
name string Human-readable name for the API key
permissions array List of permissions granted to this API key
expiry_date string Optional expiration date for the API key (must be in the future)
allowed_ips object IP restrictions for the API key. If not provided, the key can be used from any IP
View JSON Schema on GitHub

JSON Schema

stellar-sdp-createapikeyrequest.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/CreateAPIKeyRequest.json",
  "title": "CreateAPIKeyRequest",
  "type": "object",
  "required": [
    "name",
    "permissions"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the API key"
    },
    "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
    },
    "expiry_date": {
      "type": "string",
      "format": "date-time",
      "description": "Optional expiration date for the API key (must be in the future)"
    },
    "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, the key can be used from any IP"
    }
  }
}