Search…
Access Keys
Access keys are used to authenticate you with our API. You can create a new key or delete an existing key at any time. You can also temporarily disable a key.

Creating an Access Key

If you lose or forget your secret key, you cannot retrieve it. You can create a new access key and disable/delete the other. There is a limit of 2 access keys.
1
mutation {
2
createAccessKey {
3
key
4
secret
5
}
6
}
Copied!
Response Example
1
{
2
"data": {
3
"createAccessKey": {
4
"key": "YX62XXXXXXXXXX6YB",
5
"secret": "XXXXXXXXXXXXXX"
6
}
7
}
8
}
Copied!

Disable/Enable an Access Key

This request will disable/enable an existing access key. Arguments must pass the access key id (not the secret) and enabled as a boolean
1
mutation {
2
updateAccessKey(key:"YX62XXXXXXXXXX6YB", enabled: false) {
3
key
4
enabled
5
}
6
}
Copied!
Response Example
1
{
2
"data": {
3
"updateAccessKey": {
4
"key": "YX62XXXXXXXXXX6YB",
5
"enabled": false
6
}
7
}
8
}
Copied!

Delete an Access Key

This mutation will delete the access key permanently.
Any API or CLI requests using this access key will start failing authentication when this is completed.
1
mutation {
2
deleteAccessKey (key: "YXXXXXXXXXXXX6YB")
3
}
Copied!
Response Example
1
{
2
"data": {
3
"deleteAccessKey": true
4
}
5
}
Copied!
Last modified 2mo ago