{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/api_keys/","auth":"required","examples":{"codes":[{"code":"curl -X POST \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n-H \"Content-type: application/json\" \\\n-d '{\"description\": \"My api key\", \"allow_anonymous_read\": true}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/api_keys/\"","language":"curl","name":""},{"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.create()\n\nprint(api_key_instance.api_key)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar ApiKey = connection.ApiKey;\n\nvar options = {\n  \"description\": \"My api key\", \n  \"allow_user_create\": false, \n  \"ignore_acl\": false,\n  \"instanceName\": \"INSTANCE_NAME\"\n};\n\nApiKey.please().create(options).then(callback);","language":"javascript"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"551d4adc3c66970d00d20bf0"},{"name":"ignore_acl","type":"boolean","default":"false","desc":"Decide if this API Key should ignore access control list permissions.","required":false,"in":"body","ref":"","_id":"551d4e3eb2a89a230058adae"},{"name":"allow_user_create","type":"boolean","default":"false","desc":"Decide if it'll be possible to create users with this API Key.","required":false,"in":"body","ref":"","_id":"551d4e3eb2a89a230058adad"},{"name":"allow_anonymous_read","type":"boolean","default":"false","desc":"Decide if this API Key will have read access to Classes and Data Objects with permissions set to `read` or higher.","required":false,"in":"body","ref":"","_id":"569d112d3dbdc20d005fee33"},{"name":"description","type":"string","default":"","desc":"API Key description","required":false,"in":"body","ref":"","_id":"55670a8c7acd550d0075e9ff"}],"results":{"codes":[{"language":"json","status":201,"name":"","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\": \"2c4f6c5e6311cd98ea58909df29ae98cf2eca285\",\n  \"id\": 3961,\n  \"allow_user_create\": false\n}"},{"status":400,"name":"","code":"{\n  \"detail\": \"JSON parse error - No JSON object could be decoded\"\n}","language":"json"},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"API Keys - add","type":"endpoint","slug":"api-keys-add","excerpt":"","body":"Creates an API Key associated with a given instance.","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50628bdcde80d0049864a","project":"54774d9af3736008009e9e0e","__v":0,"createdAt":"2015-04-02T14:12:14.003Z","parentDoc":null,"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"},"editedParams":true,"user":"54774c47f3736008009e9e0c","editedParams2":true,"githubsync":"","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 - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

ignore_acl:
booleanfalse
Decide if this API Key should ignore access control list permissions.
allow_user_create:
booleanfalse
Decide if it'll be possible to create users with this API Key.
allow_anonymous_read:
booleanfalse
Decide if this API Key will have read access to Classes and Data Objects with permissions set to `read` or higher.
description:
string
API Key description

Examples


Result Format


Documentation

Creates an API Key associated with a given instance.

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 }}