{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/api_keys/:api_key_id/reset_key/","auth":"required","method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"551d4adc3c66970d00d20bf0"},{"name":"api_key_id","type":"int","default":"","desc":"API Key ID","required":true,"in":"path","ref":"","_id":"551d5521d4fb192f007e8359"}],"results":{"codes":[{"code":"{\n  \"created_at\": \"2016-03-17T17:49:25.535238Z\",\n  \"ignore_acl\": false,\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/api_keys/3961/\",\n    \"reset_key\": \"/v1.1/instances/rivia/api_keys/3961/reset_key/\"\n  },\n  \"allow_anonymous_read\": true,\n  \"description\": \"My api key\",\n  \"api_key\": \"b80ae4f2a34213c70d32f7626624fd8a54c4b247\",\n  \"id\": 3961,\n  \"allow_user_create\": false\n}","language":"json","status":200,"name":""},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"code":"curl -X POST \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance>/api_keys/<api_key_id>/reset_key/\"","name":"","language":"curl"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar ApiKey = connection.ApiKey;\n\nApiKey.please().reset({instanceName: \"INSTANCE_NAME\", id: 7}).then(callback);","language":"javascript"}]}},"next":{"description":"","pages":[]},"title":"API Keys - reset API Key","type":"endpoint","slug":"api-keys-reset-api-key","excerpt":"","body":"Resets an API Key associated with a given instance. ID, description, `ignore_acl`, `allow_user_create` and `allow_anonymous_read` flags will not be affected.","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50628bdcde80d0049864b","githubsync":"","__v":0,"user":"54774c47f3736008009e9e0c","createdAt":"2015-04-02T14:41:37.740Z","editedParams":true,"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50628bdcde80d00498648","56c50628bdcde80d00498649","56c50628bdcde80d0049864a","56c50628bdcde80d0049864b","56c50628bdcde80d0049864c","56c7ade5d09df50d00e015b8","56c7ae135652c217008e091b"],"title":"API Keys","slug":"api-keys","order":13,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498641","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":3,"createdAt":"2015-04-02T13:55:49.950Z"},"parentDoc":null,"project":"54774d9af3736008009e9e0e","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"}}

postAPI Keys - reset API Key


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
api_key_id:
required
integer
API Key ID

Examples


Result Format


Documentation

Resets an API Key associated with a given instance. ID, description, `ignore_acl`, `allow_user_create` and `allow_anonymous_read` flags will not be affected.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}