Entity Key¶
/api/repositories/{repository}/entities/{entity}/keys/:keyID
| Parameter | Type | Purpose |
|---|---|---|
| repository | string | the name of the Repository |
| entity | int | The ID of the entity to view |
| keyID | string | The ID for the key |
Commands¶
Edit¶
-
POST/api/repositories/(string: repository)/entities/(int: entityID)/keys/(int: keyID)¶ Edit status of the corresponding discovered or permanent key.
POST /api/repositories/alpha/entities/1/keys/1 HTTP/1.1
Content-Type: application/json
{
"command": "edit",
"data": {
"status": "Discovered"
}
}
| Response Code | Reason |
|---|---|
| 204 | No error |
| 400 | Invalid data passed with request |
| 500 | Server error |
The request requires a Standard Request packet. Available commands are:
| Command | Description |
|---|---|
| edit | Edit the status of the key to Discovered or Permanent |
The request packet must contain the command and data elements.
- Following fields should be send as part of data:
- status, string, It should be either Permanent or Discovered.