Methods
Objects
Manage authentication with Api Keys
| Method | Description |
|---|---|
| api-key.all | Get all API keys linked to your account. |
| api-key.create | Create a new Api-Key |
| api-key.delete | Delete an Api-Key |
| api-key.edit | Change the name of an API key. You can change the name of an API key l... |
api-key.all
Get all API keys linked to your account.
method: api-key.all
params: []
No parameters.
| Type | Description | Format/Object |
|---|---|---|
| array | List of API keys | Array of Authentication.ApiKey objects. |
api-key.create
Create a new Api-Key
method: api-key.create
params: [string name]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| name | string | The API key name. | NO |
| Type | Description | Format/Object |
|---|---|---|
| object | The newly created API Key | Object: Authentication.ApiKey |
api-key.delete
Delete an Api-Key
method: api-key.delete
params: [int id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | int | The id of the API key to be deleted. | NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | True if API key deleted. |
api-key.edit
Change the name of an API key.
You can change the name of an API key linked to your account.
Note: you cannot change the API key itself.
method: api-key.edit
params: [int id, string name]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| id | int | The id of the API key to be changed. | NO |
| name | string | The new name of the API key. | NO |
| Type | Description | Format/Object |
|---|---|---|
| object | The edited API Key | Object: Authentication.ApiKey |