Skip to content

API: Aliases

List of all aliases

Request

GET /api/v1/command-alias HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Add new alias

Request

POST /api/v1/command-alias HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "id": "{NAME_FOR_THE_ALIAS}",
  "description": "{ALIAS_DESCRIPTION}",
  "templateId": "{TEMPLATE_ID_USED_FOR_ALIAS}",
  "fixedConfiguration": {CONFIGURATION_FOR_ALIAS}
}

Example

POST /api/v1/command-alias HTTP/1.1
Authorization: Bearer {JWT_TOKEN}
Content-Type: application/json

{
  "id": "powershell-whoami",
  "description": "cool description about powershell-whoami",
  "templateId": "powershell",
  "fixedConfiguration": {
    "command": "whoami"
  }
}

Delete alias

Request

DELETE /api/v1/command-alias/{NAME_FOR_THE_ALIAS} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}

Show info about created alias

Request

GET /api/v1/command-alias/{NAME_FOR_THE_ALIAS} HTTP/1.1
Authorization: Bearer {JWT_TOKEN}