Whitelists

Get whitelist by id

This method returns the whitelist that matches the entered ID.

get/whitelists/{whitelist_id}

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Ledger-API-User
    • or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key
    • or API key in header X-Ledger-API-User and Ledger_Store_Auth_Token (a scheme the document does not define)
    • or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key and Ledger_Store_Auth_Token (a scheme the document does not define)

Path parameters

whitelist_idinteger required

The whitelist's ID.

Response

Whitelist object

created_byinteger required
created_onstring date-time required
descriptionstring required
idinteger required
last_requestinteger nullable
namestring required
status'ACTIVE' | 'PENDING' | 'REJECTED' | 'REVOKED' required

Changes

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