Access Keys

Create, disable and delete the access keys that authenticate you to the Remote.It API. Secret keys cannot be retrieved once lost.

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.

mutation {
  createAccessKey {
    key
    secret
  }
}

Response Example

{
  "data": {
    "createAccessKey": {
      "key": "YX62XXXXXXXXXX6YB",
      "secret": "XXXXXXXXXXXXXX"
    }
  }
}

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

mutation {
    updateAccessKey(key:"YX62XXXXXXXXXX6YB", enabled: false) {
        key
        enabled
    }
}

Response Example

{
  "data": {
    "updateAccessKey": {
      "key": "YX62XXXXXXXXXX6YB",
      "enabled": false
    }
  }
}

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.

mutation {
  deleteAccessKey (key: "YXXXXXXXXXXXX6YB") 
}

Response Example

{
  "data": {
    "deleteAccessKey": true
  }
}