Access Keys

For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

Copy

mutation {
  createAccessKey {
    key
    secret
  }
}

Response Example

Copy

{
  "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

Response Example

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.

Response Example

PreviousConnectionsNextDevice Sharing

Last updated 13 days ago

Was this helpful?