Local API admin (/localapiadmin/)
URL: https://[server_name]/api/[api_version]/localapiadmin/
This endpoint represents local admin resource with access to API only.
Supported fields
Same as the fields supported by Local users resource plus these additional ones:
Field | Display name | Type | Required | Other restrictions |
---|---|---|---|---|
trusted_hosts | Trusted subnet from which this admin is allowed to logon | list | No | List of IPv4/IPv6 subnets |
password | Password | string | No | max length = 50 |
Additionally, randomly generated api_key
would be returned as a field in response upon success. Please refer to examples for more details.
Allowed methods
HTTP method | Resource URI | Action |
---|---|---|
GET | /api/v1/localapiadmin/[id]/ | Get a specific local admin with ID id |
POST | /api/v1/localapiadmin | Create a new local admin with access to API endpoints |
DELETE | /api/v1/localapiadmin/[id]/ | Delete a local admin |