{"_id":"56c50628bdcde80d00498649","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","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"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"category":{"_id":"56c50628bdcde80d00498641","pages":["56c50628bdcde80d00498648","56c50628bdcde80d00498649","56c50628bdcde80d0049864a","56c50628bdcde80d0049864b","56c50628bdcde80d0049864c","56c7ade5d09df50d00e015b8","56c7ae135652c217008e091b"],"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":3,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-02T13:55:49.950Z","from_sync":false,"order":13,"slug":"api-keys","title":"API Keys"},"editedParams2":true,"project":"54774d9af3736008009e9e0e","user":"54774c47f3736008009e9e0c","parentDoc":null,"editedParams":true,"__v":0,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-02T14:05:14.386Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/api_keys/<api_key_id>/\"","name":""},{"language":"python","code":"import syncano\nfrom syncano.models import ApiKey\n\nconnection = syncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\napi_key_instance = ApiKey.please.get(id=API_KEY_ID)\n\nprint(api_key_instance.api_key)\n"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar ApiKey = connection.ApiKey;\n\nApiKey.please().get({instanceName: \"INSTANCE_NAME\", id: 7}).then(callback);"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"created_at\": \"2015-05-19T16:32:02.303135Z\",\n  \"ignore_acl\": true,\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/api_keys/43/\",\n    \"reset_key\": \"/v1.1/instances/rivia/api_keys/43/reset_key/\"\n  },\n  \"allow_anonymous_read\": false,\n  \"description\": \"\",\n  \"api_key\": \"ab41b03bf6d16455q26712de9ad28f1f60c3a1az\",\n  \"id\": 43,\n  \"allow_user_create\": true\n}","language":"json","status":200},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"551d4adc3c66970d00d20bf0","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"551d4c9a1bf7163700418258","ref":"","in":"path","required":true,"desc":"API Key ID","default":"","type":"int","name":"api_key_id"}],"url":"/instances/:instance_name/api_keys/:api_key_id/"},"isReference":true,"order":1,"body":"Gets details of an API Key associated with a given Instance.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You can use an API Key instead of an Account Key as an authentication method on this endpoint. This way the request will be scoped and you will only be able to see the API Key that you used to make the request.\\n\\nFor example, if you used an API Key `ab41b03bf6d16455q26712de9ad28f1f60c3a1az` with an ID `5`, you will only be able to see the API Key with an ID `5` in the response.\"\n}\n[/block]","excerpt":"","slug":"api-keys-details","type":"endpoint","title":"API Keys - details"}

getAPI Keys - details


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

Gets details of an API Key associated with a given Instance. [block:callout] { "type": "info", "body": "You can use an API Key instead of an Account Key as an authentication method on this endpoint. This way the request will be scoped and you will only be able to see the API Key that you used to make the request.\n\nFor example, if you used an API Key `ab41b03bf6d16455q26712de9ad28f1f60c3a1az` with an ID `5`, you will only be able to see the API Key with an ID `5` in the response." } [/block]

User Information

Try It Out

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