{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/apiKeys","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"apiKey\": \"AK-XXXX-YYYYY-ZZZZZ-QQQQQ\",\n  \"owner\": \"account:AC_XYZ\",\n  \"type\": \"FULL\",\n  \"desc\": \"AwesomeWallet Connection\",\n  \"secretKey\": \"SK-ZZZZ-ZZZZ-ZZZZ-ZZZZ\",\n  \"ipWhitelist\": []\n}","name":""}]},"examples":{"codes":[]},"method":"post","params":[{"name":"desc","type":"string","default":"","desc":"A description of the credentials.","required":false,"in":"body","ref":"","_id":"5c1d77ffeace490020c1b9d2"},{"name":"type","type":"string","default":"FULL","desc":"Can be `FULL` or `READONLY`","required":false,"in":"body","ref":"","_id":"5cb9266fc982de002b0ed906"},{"name":"ipWhitelist","type":"array_string","default":"[]","desc":"List of IP addresses allowed to use the key, or empty for no restrictions.","required":false,"in":"body","ref":"","_id":"5cb9266fc982de002b0ed905"}]},"next":{"description":"","pages":[]},"title":"Create API Key","type":"endpoint","slug":"create-api-key","excerpt":"Generate a new set of API credentials","body":"","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cb9266fc982de002b0ed904","project":"550f74bb6fc8130d0038aad3","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a"],"_id":"550f75de61d9d30d00af9e01","__v":22,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Key Management","slug":"auth","order":1,"from_sync":false,"reference":true,"_id":"5c1d769a4f6aed001fe527f0","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-12-21T23:26:18.126Z","__v":0},"user":"54eb8076867e1917009b7160","createdAt":"2019-04-19T01:37:51.256Z","__v":4,"parentDoc":null}

postCreate API Key

Generate a new set of API credentials

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

desc:
string
A description of the credentials.
type:
stringFULL
Can be `FULL` or `READONLY`
ipWhitelist:
array of strings[]
List of IP addresses allowed to use the key, or empty for no restrictions.

Result Format