This document describes the expected response of an API call that generates an access key. The sample data provided below is fictional and is meant to illustrate the structure and meaning of each field in the response.
{
"success": true,
"msg": "access key generated successfully",
"body": {
"id": 4257393,
"access_key": "string",
"url": null,
"status": "active",
"tipo": "API-watch-Label",
"ip_access": "string",
"created_at": "2024-11-04 10:44:02",
"updated_at": "2024-11-04 10:44:02"
}
}| Attribute | Description |
|---|---|
| id(integer) | Unique identifier of the generated access key. |
| access_key (string) | Access key generated for API authentication. |
| url (string | null) | URL associated with the access key, if applicable. |
| status (string) | Status of the access key (e.g., active, inactive). |
| tipo (string) | Type of access key, indicating its purpose (e.g., API-watch-Label). |
| ip_access (string) | IP address authorized to use the access key. |
| created_at (string) | Date and time when the access key was created in the format YYYY-MM-DD HH:MM. |
| updated_at (string) | Date and time of the last update of the access key in the format YYYY-MM-DD HH:MM. |